FullClient

agentsLimit
Type: integer

Limit on agents
description
Type: string

Client`s description
email
Type: string

Brand profile's email address
eventServerToken
Type: string

Event server token
eventServerUrl
Type: string

Event server URL
facebook
Type: string

Facebook profile link
fbAppId
Type: string

Facebook App ID
fbPixel
Type: string

Facebook Pixel ID
googleViewId
Type: string

Google View ID
hubMinutes
Type: integer

Hub minutes
instagram
Type: string

Instagram profile link
linkedin
Type: string

LinkedIn profile link
logo
Type: boolean

Is logo enabled
meetingSlotMinutes
Type: integer

Meeting slot duration in minutes
meetingSlotPpl
Type: integer

Maximum people in a meeting slot
monthlyVideoCredits
Type: integer

Monthly video credits
name
Type: string

Brand profile's name
paypalClientId
Type: string

PayPal client ID
phone
Type: string

Brand profile's phone number
primaryColor
Type: string

Primary color for branding
promotionalInfo
Type: string

Client promotional info
rtl
Type: boolean

Is right-to-left support enabled
secondaryColor
Type: string

Secondary color for branding
sso
Type: boolean

Is Single Sign-On enabled
status
Type: string enum

Brand profile status
values
- enabled
- disabled
subscriptionId
Type: string

Subscription ID
subscriptionType
Type: string enum

Type of subscription
values
- S
- M
- L
twitter
Type: string

Twitter profile link
user
Type: object · User
- access
  Type: string
- active
  Type: boolean
- admin
  Type: string
  
  Nullable
- adminId
  Type: string
  
  Nullable
- adminUrl
  Type: string
- apiKey
  Type: string
- appId
  Type: string
  
  Nullable
- AWSAccountId
  Type: string
  
  Nullable
- AWSIdentifier
  Type: string
  
  Nullable
- AWSProductCode
  Type: string
  
  Nullable
- clientsLimit
  Type: integer
  
  Integer numbers.
- cloudfrontId
  Type: string
  
  Nullable
- company
  Type: string
- confirmed
  Type: boolean
- country
  Type: string
- createdAt
  Type: string Format: date-time
  
  the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- domainUrl
  Type: string
- email
  Type: string
- enterprise
  Type: boolean
- fbAppId
  Type: string
- fbPixel
  Type: string
  
  Nullable
- freeAR
  Type: boolean
- freeAvatar
  Type: boolean
- freeExperience
  Type: boolean
- freeTicketing
  Type: boolean
- freeVCommerce
  Type: boolean
- giphyAPIKey
  Type: string
- googleViewId
  Type: string
- hearPlace
  Type: string
  
  Nullable
- helpCenterUrl
  Type: string
  
  Nullable
- hostInstallation
  Type: boolean
- hostPassword
  Type: string
  
  Nullable
- hostUrl
  Type: string
  
  Nullable
- hostUser
  Type: string
  
  Nullable
- hubMinutes
  Type: integer
  
  Integer numbers.
- id
  Type: integer
  
  Integer numbers.
- isNewAdmin
  Type: boolean
- isYad2
  Type: boolean
- lastCreditsPurchase
  Type: string Format: date-time
  
  the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- logo
  Type: string
- logoUrl
  Type: string
- manualSubscription
  Type: boolean
- mode
  Type: string
- mpSDK
  Type: string
- mpTokenId
  Type: string
  
  Nullable
- mpTokenSecret
  Type: string
  
  Nullable
- name
  Type: string
- newsletterEnabled
  Type: boolean
- oauth
  Type: boolean
- oauthExpire
  Type: string
  
  Nullable
- oauthRefresh
  Type: string
  
  Nullable
- oauthToken
  Type: string
  
  Nullable
- phone
  Type: string
  
  Nullable
- pinTwoFA
  Type: string
- primaryColor
  Type: string
- profile
  Type: string
- purchasedCredits
  Type: integer
  
  Integer numbers.
- refer
  Type: string
  
  Nullable
- secondaryColor
  Type: string
- sfAccessToken
  Type: string
- sfRefreshToken
  Type: string
- sfTokenExpires
  Type: string Format: date-time
  
  the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- sfUsername
  Type: string
  
  Nullable
- sitePlanPrice
  Type: number
- sso
  Type: boolean
- stripeId
  Type: string
- subscription
  Type: string
- subscriptionCycle
  Type: string
  
  Nullable
- subscriptionId
  Type: string
- subscriptionStart
  Type: string Format: date-time
  
  the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- supportWidgetUrl
  Type: string
  
  Nullable
- taxId
  Type: string
  
  Nullable
- threeDFloorPlanFloors
  Type: integer
  
  Integer numbers.
- threeDFloorPlanThreeDColorPrice
  Type: number
- timezone
  Type: integer
  
  Integer numbers.
- tmpEmail
  Type: string
- token
  Type: string
  
  Nullable
- toursLimit
  Type: integer
  
  Integer numbers.
- trialActivated
  Type: boolean
- twoDFloorPlanCadFilePrice
  Type: number
- twoDFloorPlanFloors
  Type: integer
  
  Integer numbers.
- twoDFloorPlanPrice
  Type: number
- twoDFloorPlanTwoDColorPrice
  Type: number
- twoDFourteenHoursDelivery
  Type: number
- twoDSixHoursDelivery
  Type: number
- twoFA
  Type: boolean
- type
  Type: string
- updatedAt
  Type: string Format: date-time
  
  the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- username
  Type: string
- videoCredits
  Type: integer
  
  Integer numbers.
- website
  Type: string
- whitelabelConfig
  Type: string
- whitelabelEmail
  Type: string
  
  Nullable
- whitelabelId
  Type: string
- wlBundle
  Type: boolean
- yad2CrmId
  Type: string
  
  Yad2CrmId
- yad2Subscription
  Type: string enum
  values
  basic
  pro
  platinum
  multi
videoCredits
Type: integer

Total video credits
vimeoToken
Type: string

Vimeo token
watermark
Type: boolean

Is watermark enabled
website
Type: string

Brand profile's website
whitelabelId
Type: string

Whitelabel ID
whitelabelLogo
Type: boolean

Is whitelabel logo enabled
widthLogo
Type: boolean

Is width logo enabled
yad2CrmId
Type: string

Yad2CrmId