docs.jsonld
type: ApiDocumentation
title: API title
description: API description
entrypoint: /api
supported class: ActiveUser
supported class: Anniversary
supported class: AnniversaryMessage
supported class: Audience
supported class: AudienceFiltered
supported class: BackgroundFile
supported class: Booking
supported class: BookingConfig
supported class: BookingTime
supported class: Widget
supported class: GoogleFeed
supported class: BusinessTag
supported class: Campaign
supported class: CampaignUserContact
supported class: Faq
supported class: FaqGrp
supported class: FreeBookingCategory
supported class: FreeBookingEvent
supported class: FreeBookingField
supported class: Schedule
supported class: Stats
supported class: User
supported class: UserContact
supported class: WhatsappOperator
supported class: WhatsappTemplate
supported class: WidgetServiceIdStats
supported class: WidgetStats
supported class: Entrypoint
supported class: ConstraintViolation
supported class: ConstraintViolationList

ActiveUser
type: Class
title: ActiveUser
supported operation: Retrieves a ActiveUser resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ActiveUser resource.
  returns: Nothing

Anniversary
type: Class
title: Anniversary
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: active
  title: active
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: timeZone
  title: timeZone
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: timeSend
  title: timeSend
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Anniversary resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Anniversary resource.
  returns: Anniversary
supported operation: Replaces the Anniversary resource.
  type: Operation
  type: ReplaceAction
  expects: Anniversary
  method: PUT
  title: Replaces the Anniversary resource.
  returns: Anniversary
supported operation: Deletes the Anniversary resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Anniversary resource.
  returns: Nothing

name
type: Property
domain: Anniversary
range: string

active
type: Property
domain: Anniversary
range: boolean

timeZone
type: Property
domain: Anniversary
range: string

timeSend
type: Property
domain: Anniversary
range: dateTime

AnniversaryMessage
type: Class
title: AnniversaryMessage
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: anniversary
  title: anniversary
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: phone
  title: phone
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: date
  title: date
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: dateGmt
  title: dateGmt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: placeholders
  title: placeholders
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: send
  title: send
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: errorMessage
  title: errorMessage
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: successResponse
  title: successResponse
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: wId
  title: wId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: wIsSent
  title: wIsSent
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: wSentDatetime
  title: wSentDatetime
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: wIsDelivered
  title: wIsDelivered
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: wDeliveredDatetime
  title: wDeliveredDatetime
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: wIsRead
  title: wIsRead
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: wReadDatetime
  title: wReadDatetime
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a AnniversaryMessage resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a AnniversaryMessage resource.
  returns: AnniversaryMessage

id
type: Property
domain: AnniversaryMessage
range: integer

anniversary
type: Link
domain: AnniversaryMessage
max cardinality: 1
range: Anniversary

phone
type: Property
domain: AnniversaryMessage
range: string

date
type: Property
domain: AnniversaryMessage
range: dateTime

dateGmt
type: Property
domain: AnniversaryMessage
range: dateTime

placeholders
type: Property
domain: AnniversaryMessage
range: string

send
type: Property
domain: AnniversaryMessage
range: boolean

errorMessage
type: Property
domain: AnniversaryMessage

successResponse
type: Property
domain: AnniversaryMessage

createdAt
type: Property
domain: AnniversaryMessage
range: dateTime

updatedAt
type: Property
domain: AnniversaryMessage
range: dateTime

wId
type: Property
domain: AnniversaryMessage
range: string

wIsSent
type: Property
domain: AnniversaryMessage
range: boolean

wSentDatetime
type: Property
domain: AnniversaryMessage
range: dateTime

wIsDelivered
type: Property
domain: AnniversaryMessage
range: boolean

wDeliveredDatetime
type: Property
domain: AnniversaryMessage
range: dateTime

wIsRead
type: Property
domain: AnniversaryMessage
range: boolean

wReadDatetime
type: Property
domain: AnniversaryMessage
range: dateTime

Audience
type: Class
title: Audience
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: created
  title: created
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: columns
  title: columns
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: columnPhoneNumber
  title: columnPhoneNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: items
  title: items
  required: false
  readable: false
  writeable: true
  description: Array of dynamic objects
supported property: SupportedProperty
  property: inProcess
  title: inProcess
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: isAutomaticGeneration
  title: isAutomaticGeneration
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: providerWhatsapp
  title: providerWhatsapp
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: automaticGenerationMessage
  title: automaticGenerationMessage
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: errorAutomaticGeneration
  title: errorAutomaticGeneration
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: totalUserContacts
  title: totalUserContacts
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a Audience resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Audience resource.
  returns: Audience
supported operation: Replaces the Audience resource.
  type: Operation
  type: ReplaceAction
  expects: Audience
  method: PUT
  title: Replaces the Audience resource.
  returns: Audience
supported operation: Deletes the Audience resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Audience resource.
  returns: Nothing
supported operation: Replaces the Audience resource.
  type: Operation
  type: ReplaceAction
  expects: Audience
  method: PUT
  title: Replaces the Audience resource.
  returns: Nothing
supported operation: Deletes the Audience resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Audience resource.
  returns: Nothing
supported operation: Replaces the Audience resource.
  type: Operation
  type: ReplaceAction
  expects: Audience
  method: PUT
  title: Replaces the Audience resource.
  returns: Audience

name
type: Property
domain: Audience
range: string

created
type: Property
domain: Audience
range: dateTime

columns
type: Property
domain: Audience

columnPhoneNumber
type: Property
domain: Audience
range: string

items
type: Property
domain: Audience

inProcess
type: Property
domain: Audience
range: boolean

isAutomaticGeneration
type: Property
domain: Audience
range: boolean

providerWhatsapp
type: Property
domain: Audience
max cardinality: 1
range: WhatsappOperator

automaticGenerationMessage
type: Property
domain: Audience
range: string

errorAutomaticGeneration
type: Property
domain: Audience
range: boolean

totalUserContacts
type: Property
domain: Audience

AudienceFiltered
type: Class
title: AudienceFiltered
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: audience
  title: audience
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: audienceName
  title: audienceName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: filters
  title: filters
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: audienceNewId
  title: audienceNewId
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a AudienceFiltered resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a AudienceFiltered resource.
  returns: Nothing

id
type: Property
domain: AudienceFiltered
range: integer

audience
type: Link
domain: AudienceFiltered
max cardinality: 1
range: Audience

audienceName
type: Property
domain: AudienceFiltered
range: string

filters
type: Property
domain: AudienceFiltered

audienceNewId
type: Property
domain: AudienceFiltered
range: integer

type
type: Property
domain: AudienceFiltered
range: string

BackgroundFile
type: Class
title: BackgroundFile
supported property: SupportedProperty
  property: filename
  title: filename
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: path
  title: path
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a BackgroundFile resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a BackgroundFile resource.
  returns: Nothing

filename
type: Property
domain: BackgroundFile
range: string

path
type: Property
domain: BackgroundFile
range: string

Booking
type: Class
title: Booking
supported property: SupportedProperty
  property: bookingConfig
  title: bookingConfig
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: stat
  title: stat
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: startTime
  title: startTime
  required: false
  readable: true
  writeable: true
  description: UTC Time.
supported property: SupportedProperty
  property: endTime
  title: endTime
  required: false
  readable: true
  writeable: true
  description: UTC Time.
supported property: SupportedProperty
  property: clientTimezone
  title: clientTimezone
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: created
  title: created
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: confirmed
  title: confirmed
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: termsAccepted
  title: termsAccepted
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Booking resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Booking resource.
  returns: Booking
supported operation: Deletes the Booking resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Booking resource.
  returns: Nothing

bookingConfig
type: Property
domain: Booking
max cardinality: 1
range: BookingConfig

stat
type: Property
domain: Booking
max cardinality: 1
range: Stats

startTime
type: Property
domain: Booking
range: dateTime

endTime
type: Property
domain: Booking
range: dateTime

clientTimezone
type: Property
domain: Booking
range: string

created
type: Property
domain: Booking
range: dateTime

confirmed
type: Property
domain: Booking
range: boolean

termsAccepted
type: Property
domain: Booking
range: boolean

BookingConfig
type: Class
title: BookingConfig
supported property: SupportedProperty
  property: whatsapp
  title: whatsapp
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: true
  readable: true
  writeable: false
supported property: SupportedProperty
  property: startDate
  title: startDate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: endDate
  title: endDate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: duration
  title: duration
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: breakTime
  title: breakTime
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: availablePlacePerSlot
  title: availablePlacePerSlot
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: allowedHourUntilBooking
  title: allowedHourUntilBooking
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: maximumDayMakeBooking
  title: maximumDayMakeBooking
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: bookingTimes
  title: bookingTimes
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: timezone
  title: timezone
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sendReminder
  title: sendReminder
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sendReminder48
  title: sendReminder48
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: cancelBookingInReminder
  title: cancelBookingInReminder
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sendUrlGoogleReview
  title: sendUrlGoogleReview
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: blockingDays
  title: blockingDays
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sendReminders
  title: sendReminders
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sendReminderText
  title: sendReminderText
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sendPaymentLink
  title: sendPaymentLink
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sendNps
  title: sendNps
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sendThanks
  title: sendThanks
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sendNewBooking
  title: sendNewBooking
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: active
  title: active
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sendWhatsappNotificationToAgent
  title: sendWhatsappNotificationToAgent
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sendWhatsappNotificationToClient
  title: sendWhatsappNotificationToClient
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sendEmailNotificationToClient
  title: sendEmailNotificationToClient
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: use24HourTimeFormat
  title: use24HourTimeFormat
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: orderBookingForm
  title: orderBookingForm
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: confirmBooking
  title: confirmBooking
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: termsAccepted
  title: termsAccepted
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: termsDocumentUrl
  title: termsDocumentUrl
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a BookingConfig resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a BookingConfig resource.
  returns: BookingConfig
supported operation: Replaces the BookingConfig resource.
  type: Operation
  type: ReplaceAction
  expects: BookingConfig
  method: PUT
  title: Replaces the BookingConfig resource.
  returns: BookingConfig
supported operation: Deletes the BookingConfig resource.

whatsapp
type: Link
domain: BookingConfig
max cardinality: 1
range: WhatsappOperator

name
type: Property
domain: BookingConfig
range: string

startDate
type: Property
domain: BookingConfig
range: dateTime

endDate
type: Property
domain: BookingConfig
range: dateTime

duration
type: Property
domain: BookingConfig
range: integer

breakTime
type: Property
domain: BookingConfig
range: integer

availablePlacePerSlot
type: Property
domain: BookingConfig
range: integer

allowedHourUntilBooking
type: Property
domain: BookingConfig
range: integer

maximumDayMakeBooking
type: Property
domain: BookingConfig
range: integer

bookingTimes
type: Property
domain: BookingConfig
range: BookingTime

timezone
type: Property
domain: BookingConfig
range: string

sendReminder
type: Property
domain: BookingConfig
range: boolean

sendReminder48
type: Property
domain: BookingConfig
range: boolean

cancelBookingInReminder
type: Property
domain: BookingConfig
range: boolean

sendUrlGoogleReview
type: Property
domain: BookingConfig
range: boolean

blockingDays
type: Property
domain: BookingConfig
range: string

sendReminders
type: Property
domain: BookingConfig
range: string

sendReminderText
type: Property
domain: BookingConfig
range: string

sendPaymentLink
type: Property
domain: BookingConfig
range: string

sendNps
type: Property
domain: BookingConfig
range: string

sendThanks
type: Property
domain: BookingConfig
range: string

sendNewBooking
type: Property
domain: BookingConfig
range: string

active
type: Property
domain: BookingConfig
range: boolean

sendWhatsappNotificationToAgent
type: Property
domain: BookingConfig
range: boolean

sendWhatsappNotificationToClient
type: Property
domain: BookingConfig
range: boolean

sendEmailNotificationToClient
type: Property
domain: BookingConfig
range: boolean

use24HourTimeFormat
type: Property
domain: BookingConfig
range: boolean

orderBookingForm
type: Property
domain: BookingConfig
range: boolean

confirmBooking
type: Property
domain: BookingConfig
range: boolean

termsAccepted
type: Property
domain: BookingConfig
range: boolean

termsDocumentUrl
type: Property
domain: BookingConfig
range: string

BookingTime
type: Class
title: BookingTime
supported property: SupportedProperty
  property: day
  title: day
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: availableFrom
  title: availableFrom
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: availableUntil
  title: availableUntil
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a BookingTime resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a BookingTime resource.
  returns: BookingTime

day
type: Property
domain: BookingTime
range: string

availableFrom
type: Property
domain: BookingTime
range: dateTime

availableUntil
type: Property
domain: BookingTime
range: dateTime

Widget
type: Class
title: Widget
supported property: SupportedProperty
  property: name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: color
  title: color
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: rightpos
  title: rightpos
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: active
  title: active
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isopen
  title: isopen
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: buttonMessage
  title: buttonMessage
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: widgetMessage
  title: widgetMessage
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: iconUrl
  title: iconUrl
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: whatsappIconUrl
  title: whatsappIconUrl
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: zIndex
  title: zIndex
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: bannerUrl
  title: bannerUrl
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ActivateBanner
  title: ActivateBanner
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: returningBannerUrl
  title: returningBannerUrl
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: openOnce
  title: openOnce
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: showAllAgents
  title: showAllAgents
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: showLessAgents
  title: showLessAgents
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: legend
  title: legend
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: backgroundImageUrl
  title: backgroundImageUrl
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: theme
  title: theme
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: offlineMessage
  title: offlineMessage
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: requiredValidationText
  title: requiredValidationText
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: emailValidationText
  title: emailValidationText
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: landingPrimaryColor
  title: landingPrimaryColor
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: landingSecondaryColor
  title: landingSecondaryColor
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: slug
  title: slug
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WelcomeBackMessage
  title: WelcomeBackMessage
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: transYourPhone
  title: transYourPhone
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: telValidationText
  title: telValidationText
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: landingDateTime
  title: landingDateTime
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: landingTimezone
  title: landingTimezone
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: landingLegal
  title: landingLegal
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: showBannerLanding
  title: showBannerLanding
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: landingShowStore
  title: landingShowStore
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a Widget resource.
supported operation: Replaces the Widget resource.
supported operation: Updates the Widget resource.
supported operation: Deletes the Widget resource.

name
type: Property
domain: Widget
range: string

color
type: Property
domain: Widget
range: string

rightpos
type: Property
domain: Widget
range: boolean

active
type: Property
domain: Widget
range: boolean

isopen
type: Property
domain: Widget
range: boolean

buttonMessage
type: Property
domain: Widget
range: string

widgetMessage
type: Property
domain: Widget
range: string

iconUrl
type: Property
domain: Widget
range: string

whatsappIconUrl
type: Property
domain: Widget
range: string

zIndex
type: Property
domain: Widget
range: integer

bannerUrl
type: Property
domain: Widget
range: string

ActivateBanner
type: Property
domain: Widget
range: boolean

returningBannerUrl
type: Property
domain: Widget
range: string

openOnce
type: Property
domain: Widget
range: boolean

showAllAgents
type: Property
domain: Widget
range: string

showLessAgents
type: Property
domain: Widget
range: string

legend
type: Property
domain: Widget
range: string

backgroundImageUrl
type: Property
domain: Widget
range: string

theme
type: Property
domain: Widget
range: integer

offlineMessage
type: Property
domain: Widget
range: string

requiredValidationText
type: Property
domain: Widget
range: string

emailValidationText
type: Property
domain: Widget
range: string

landingPrimaryColor
type: Property
domain: Widget
range: string

landingSecondaryColor
type: Property
domain: Widget
range: string

slug
type: Property
domain: Widget
range: string

WelcomeBackMessage
type: Property
domain: Widget
range: string

transYourPhone
type: Property
domain: Widget
range: string

telValidationText
type: Property
domain: Widget
range: string

landingDateTime
type: Property
domain: Widget
range: dateTime

landingTimezone
type: Property
domain: Widget
range: string

landingLegal
type: Property
domain: Widget
range: string

showBannerLanding
type: Property
domain: Widget
range: boolean

landingShowStore
type: Property
domain: Widget
range: boolean

landingShowQR
type: Property
domain: Widget
range: boolean

faqsChatBotQuestionText
type: Property
domain: Widget
range: string

faqsChatBotNotSolvedText
type: Property
domain: Widget
range: string

translateOnlineFrom
type: Property
domain: Widget
range: string

translateShowTimetable
type: Property
domain: Widget
range: string

userClient
type: Property
domain: Widget
range: string

transSuccessMessage
type: Property
domain: Widget
range: string

defaultLanguage
type: Property
domain: Widget
range: string

landingFacebookPixel
type: Property
domain: Widget
range: string

landingGoogleAnalytics
type: Property
domain: Widget
range: string

landingGoogleTagManager
type: Property
domain: Widget
range: string

landingGetconver
type: Property
domain: Widget
range: string

businessTags
type: Property
domain: Widget
range: BusinessTag

cookiesDescription
type: Property
domain: Widget
range: string

cookiesTitle
type: Property
domain: Widget
range: string

translateChatAnswer
type: Property
domain: Widget
range: string

enableCookieBanner
type: Property
domain: Widget
range: boolean

haltBusiness
type: Property
domain: Widget
range: boolean

landingPrivacy
type: Property
domain: Widget
range: string

landingTermsAndConditions
type: Property
domain: Widget
range: string

alliance
type: Property
domain: Widget
range: string

landingTel
type: Property
domain: Widget
range: string

landingAddress
type: Property
domain: Widget
range: string

landingExtraText
type: Property
domain: Widget
range: string

removeSocialSharing
type: Property
domain: Widget
range: boolean

landingShowYoutubeVideo
type: Property
domain: Widget
range: boolean

landingYoutubeVideo
type: Property
domain: Widget
range: string

customCss
type: Property
domain: Widget
range: string

saveDataInWidget
type: Property
domain: Widget
range: boolean

landingShowGalleryImages
type: Property
domain: Widget
range: boolean

landingGalleryImages
type: Property
domain: Widget
range: string

noFollow
type: Property
domain: Widget
range: boolean

showBrandInWidget
type: Property
domain: Widget
range: boolean

keepBannerWithFormNewUser
type: Property
domain: Widget
range: boolean

keepBannerWithFormOldUser
type: Property
domain: Widget
range: boolean

translateChatWithAgent
type: Property
domain: Widget
range: string

landingShowWhatsappAnchorOnMobile
type: Property
domain: Widget
range: boolean

extraLinksFirst
type: Property
domain: Widget
range: boolean

hideExtraLinksOnMobile
type: Property
domain: Widget
range: boolean

hideExtraLinksOnDesktop
type: Property
domain: Widget
range: boolean

pinInMarketplace
type: Property
domain: Widget
range: boolean

landingShowVCard
type: Property
domain: Widget
range: boolean

easyWidgetConfiguration
type: Property
domain: Widget
range: boolean

GoogleFeed
type: Class
title: GoogleFeed
supported property: SupportedProperty
  property: unstructuredAddress
  title: unstructuredAddress
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: showGoogleReservation
  title: showGoogleReservation
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: statusGoogleReservation
  title: statusGoogleReservation
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: countryCode
  title: countryCode
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: locality
  title: locality
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: region
  title: region
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: postalCode
  title: postalCode
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: streetAddress
  title: streetAddress
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: serviceName
  title: serviceName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: serviceDescription
  title: serviceDescription
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a GoogleFeed resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a GoogleFeed resource.
  returns: GoogleFeed
supported operation: Replaces the GoogleFeed resource.
  type: Operation
  type: ReplaceAction
  expects: GoogleFeed
  method: PUT
  title: Replaces the GoogleFeed resource.
  returns: GoogleFeed
supported operation: Deletes the GoogleFeed resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the GoogleFeed resource.
  returns: Nothing

unstructuredAddress
type: Property
domain: GoogleFeed
range: string

showGoogleReservation
type: Property
domain: GoogleFeed
range: boolean

statusGoogleReservation
type: Property
domain: GoogleFeed
range: integer

countryCode
type: Property
domain: GoogleFeed
range: string

locality
type: Property
domain: GoogleFeed
range: string

region
type: Property
domain: GoogleFeed
range: string

postalCode
type: Property
domain: GoogleFeed
range: string

streetAddress
type: Property
domain: GoogleFeed
range: string

serviceName
type: Property
domain: GoogleFeed
range: string

serviceDescription
type: Property
domain: GoogleFeed
range: string

BusinessTag
type: Class
title: BusinessTag
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: position
  title: position
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: businesses
  title: businesses
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a BusinessTag resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a BusinessTag resource.
  returns: BusinessTag

name
type: Property
domain: BusinessTag
range: string

position
type: Property
domain: BusinessTag
range: integer

user
type: Link
domain: BusinessTag
max cardinality: 1
range: User

businesses
type: Link
domain: BusinessTag
range: Widget

Campaign
type: Class
title: Campaign
supported property: SupportedProperty
  property: text
  title: text
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: fileBase64
  title: fileBase64
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: created
  title: created
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updated
  title: updated
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: audience
  title: audience
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: userManages
  title: userManages
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: totalCampaignUserContacts
  title: totalCampaignUserContacts
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a Campaign resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Campaign resource.
  returns: Campaign
supported operation: Replaces the Campaign resource.
  type: Operation
  type: ReplaceAction
  expects: Campaign
  method: PUT
  title: Replaces the Campaign resource.
  returns: Nothing
supported operation: Deletes the Campaign resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Campaign resource.
  returns: Nothing

text
type: Property
domain: Campaign
range: string

fileBase64
type: Property
domain: Campaign
range: string

name
type: Property
domain: Campaign
range: string

created
type: Property
domain: Campaign
range: dateTime

updated
type: Property
domain: Campaign
range: dateTime

audience
type: Property
domain: Campaign
max cardinality: 1
range: Audience

userManages
type: Property
domain: Campaign

totalCampaignUserContacts
type: Property
domain: Campaign
range: integer

CampaignUserContact
type: Class
title: CampaignUserContact
supported property: SupportedProperty
  property: data
  title: data
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a CampaignUserContact resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a CampaignUserContact resource.
  returns: Nothing

data
type: Property
domain: CampaignUserContact

Faq
type: Class
title: Faq
supported operation: Retrieves a Faq resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Faq resource.
  returns: Faq

FaqGrp
type: Class
title: FaqGrp
supported property: SupportedProperty
  property: title
  title: title
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: whatsapp
  title: whatsapp
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: solvedButton
  title: solvedButton
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: aiCollectEmail
  title: aiCollectEmail
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: aiCollectName
  title: aiCollectName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isAi
  title: isAi
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: faqs
  title: faqs
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: aiCollectData
  title: aiCollectData
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: hideWhatsappButton
  title: hideWhatsappButton
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: showWhatsappBtnWhenUnknown
  title: showWhatsappBtnWhenUnknown
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: softFollowUp
  title: softFollowUp
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sitemapUrl
  title: sitemapUrl
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: lastSitemapScan
  title: lastSitemapScan
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sitemapMd5
  title: sitemapMd5
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: commonQuestions
  title: commonQuestions
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a FaqGrp resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a FaqGrp resource.
  returns: FaqGrp
supported operation: Replaces the FaqGrp resource.
  type: Operation
  type: ReplaceAction
  expects: FaqGrp
  method: PUT
  title: Replaces the FaqGrp resource.
  returns: FaqGrp
supported operation: Deletes the FaqGrp resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the FaqGrp resource.
  returns: Nothing

title
type: Property
domain: FaqGrp
range: string

whatsapp
type: Link
domain: FaqGrp
max cardinality: 1
range: WhatsappOperator

solvedButton
type: Property
domain: FaqGrp
range: string

aiCollectEmail
type: Property
domain: FaqGrp
range: boolean

aiCollectName
type: Property
domain: FaqGrp
range: boolean

isAi
type: Property
domain: FaqGrp
range: boolean

faqs
type: Property
domain: FaqGrp
range: Faq

aiCollectData
type: Property
domain: FaqGrp
range: boolean

hideWhatsappButton
type: Property
domain: FaqGrp
range: boolean

showWhatsappBtnWhenUnknown
type: Property
domain: FaqGrp
range: boolean

softFollowUp
type: Property
domain: FaqGrp
range: boolean

sitemapUrl
type: Property
domain: FaqGrp
range: string

lastSitemapScan
type: Property
domain: FaqGrp
range: dateTime

sitemapMd5
type: Property
domain: FaqGrp
range: string

commonQuestions
type: Property
domain: FaqGrp

FreeBookingCategory
type: Class
title: FreeBookingCategory
supported property: SupportedProperty
  property: writtenName
  title: writtenName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: code
  title: code
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: deleted
  title: deleted
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: created
  title: created
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: modified
  title: modified
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: duration
  title: duration
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: whatsapp
  title: whatsapp
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: freeBookingEvents
  title: freeBookingEvents
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a FreeBookingCategory resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a FreeBookingCategory resource.
  returns: FreeBookingCategory

writtenName
type: Property
domain: FreeBookingCategory
range: string

code
type: Property
domain: FreeBookingCategory
range: string

deleted
type: Property
domain: FreeBookingCategory
range: boolean

created
type: Property
domain: FreeBookingCategory
range: dateTime

modified
type: Property
domain: FreeBookingCategory
range: dateTime

duration
type: Property
domain: FreeBookingCategory
range: integer

whatsapp
type: Property
domain: FreeBookingCategory
max cardinality: 1
range: WhatsappOperator

freeBookingEvents
type: Property
domain: FreeBookingCategory
range: FreeBookingEvent

FreeBookingEvent
type: Class
title: FreeBookingEvent
supported property: SupportedProperty
  property: proposedStartTime
  title: proposedStartTime
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: proposedStopTime
  title: proposedStopTime
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: proposedDuration
  title: proposedDuration
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: agreedStartTime
  title: agreedStartTime
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: agreedStopTime
  title: agreedStopTime
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: adminAccepted
  title: adminAccepted
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: created
  title: created
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: modified
  title: modified
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: stat
  title: stat
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: whatsapp
  title: whatsapp
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: category
  title: category
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a FreeBookingEvent resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a FreeBookingEvent resource.
  returns: FreeBookingEvent
supported operation: Replaces the FreeBookingEvent resource.
  type: Operation
  type: ReplaceAction
  expects: FreeBookingEvent
  method: PUT
  title: Replaces the FreeBookingEvent resource.
  returns: FreeBookingEvent
supported operation: Deletes the FreeBookingEvent resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the FreeBookingEvent resource.
  returns: Nothing

proposedStartTime
type: Property
domain: FreeBookingEvent
range: dateTime

proposedStopTime
type: Property
domain: FreeBookingEvent
range: dateTime

proposedDuration
type: Property
domain: FreeBookingEvent
range: integer

agreedStartTime
type: Property
domain: FreeBookingEvent
range: dateTime

agreedStopTime
type: Property
domain: FreeBookingEvent
range: dateTime

adminAccepted
type: Property
domain: FreeBookingEvent
range: boolean

created
type: Property
domain: FreeBookingEvent
range: dateTime

modified
type: Property
domain: FreeBookingEvent
range: dateTime

stat
type: Property
domain: FreeBookingEvent
max cardinality: 1
range: Stats

whatsapp
type: Property
domain: FreeBookingEvent
max cardinality: 1
range: WhatsappOperator

category
type: Property
domain: FreeBookingEvent
max cardinality: 1
range: FreeBookingCategory

FreeBookingField
type: Class
title: FreeBookingField
supported property: SupportedProperty
  property: uuid
  title: uuid
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: whatsapp
  title: whatsapp
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: created
  title: created
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: modified
  title: modified
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: freeBookingCategories
  title: freeBookingCategories
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: bookingType
  title: bookingType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sendReminders
  title: sendReminders
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sendRemindersBefore
  title: sendRemindersBefore
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sendReminderText
  title: sendReminderText
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sendThanks
  title: sendThanks
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sendThanksAfter
  title: sendThanksAfter
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sendNewBooking
  title: sendNewBooking
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sendNewBookingAfter
  title: sendNewBookingAfter
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: freeBookingEvents
  title: freeBookingEvents
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sendThanksReview
  title: sendThanksReview
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: deleteOldNoAccepted
  title: deleteOldNoAccepted
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: confirmBooking
  title: confirmBooking
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: freeBookingAdvancedConfig
  title: freeBookingAdvancedConfig
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a FreeBookingField resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a FreeBookingField resource.
  returns: FreeBookingField
supported operation: Replaces the FreeBookingField resource.
  type: Operation
  type: ReplaceAction
  expects: FreeBookingField
  method: PUT
  title: Replaces the FreeBookingField resource.
  returns: FreeBookingField
supported operation: Updates the FreeBookingField resource.
  type: Operation
  expects: FreeBookingField
  method: PATCH
  title: Updates the FreeBookingField resource.
  returns: FreeBookingField
supported operation: Deletes the FreeBookingField resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the FreeBookingField resource.
  returns: Nothing

uuid
type: Property
domain: FreeBookingField

name
type: Property
domain: FreeBookingField
range: string

whatsapp
type: Link
domain: FreeBookingField
max cardinality: 1
range: WhatsappOperator

created
type: Property
domain: FreeBookingField
range: dateTime

modified
type: Property
domain: FreeBookingField
range: dateTime

freeBookingCategories
type: Link
domain: FreeBookingField
range: FreeBookingCategory

bookingType
type: Property
domain: FreeBookingField
range: string

sendReminders
type: Property
domain: FreeBookingField
range: boolean

sendRemindersBefore
type: Property
domain: FreeBookingField

sendReminderText
type: Property
domain: FreeBookingField
range: string

sendThanks
type: Property
domain: FreeBookingField
range: boolean

sendThanksAfter
type: Property
domain: FreeBookingField

sendNewBooking
type: Property
domain: FreeBookingField
range: boolean

sendNewBookingAfter
type: Property
domain: FreeBookingField

freeBookingEvents
type: Link
domain: FreeBookingField
range: FreeBookingEvent

sendThanksReview
type: Property
domain: FreeBookingField
range: boolean

deleteOldNoAccepted
type: Property
domain: FreeBookingField
range: boolean

confirmBooking
type: Property
domain: FreeBookingField
range: boolean

freeBookingAdvancedConfig
type: Property
domain: FreeBookingField

Schedule
type: Class
title: Schedule
supported property: SupportedProperty
  property: messageToSend
  title: messageToSend
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: monday
  title: monday
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: tuesday
  title: tuesday
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: wednesday
  title: wednesday
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: thursday
  title: thursday
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: friday
  title: friday
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: saturday
  title: saturday
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sunday
  title: sunday
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sent
  title: sent
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: repeatSend
  title: repeatSend
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: dateFrom
  title: dateFrom
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: dateTo
  title: dateTo
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: timeSend
  title: timeSend
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: timeZone
  title: timeZone
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: template
  title: template
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: templateName
  title: templateName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: templateLanguage
  title: templateLanguage
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: activated
  title: activated
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: userList
  title: userList
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: parameters
  title: parameters
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: parametersHeader
  title: parametersHeader
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: buttons
  title: buttons
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: fromDateTime
  title: fromDateTime
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: version
  title: version
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: config
  title: config
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: headerBase64
  title: headerBase64
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: quickReply
  title: quickReply
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: columnsUsed
  title: columnsUsed
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: timeSendString
  title: timeSendString
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: created
  title: created
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updated
  title: updated
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: audience
  title: audience
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Schedule resource.
supported operation: Replaces the Schedule resource.
supported operation: Deletes the Schedule resource.

messageToSend
type: Property
domain: Schedule
range: string

monday
type: Property
domain: Schedule
range: boolean

tuesday
type: Property
domain: Schedule
range: boolean

wednesday
type: Property
domain: Schedule
range: boolean

thursday
type: Property
domain: Schedule
range: boolean

friday
type: Property
domain: Schedule
range: boolean

saturday
type: Property
domain: Schedule
range: boolean

sunday
type: Property
domain: Schedule
range: boolean

sent
type: Property
domain: Schedule
range: boolean

repeatSend
type: Property
domain: Schedule
range: boolean

dateFrom
type: Property
domain: Schedule
range: dateTime

dateTo
type: Property
domain: Schedule
range: dateTime

timeSend
type: Property
domain: Schedule
range: dateTime

timeZone
type: Property
domain: Schedule
range: string

template
type: Property
domain: Schedule

templateName
type: Property
domain: Schedule
range: string

templateLanguage
type: Property
domain: Schedule
range: string

activated
type: Property
domain: Schedule
range: boolean

userList
type: Property
domain: Schedule
range: string

parameters
type: Property
domain: Schedule

parametersHeader
type: Property
domain: Schedule

buttons
type: Property
domain: Schedule

fromDateTime
type: Property
domain: Schedule

version
type: Property
domain: Schedule
range: string

config
type: Property
domain: Schedule
range: boolean

headerBase64
type: Property
domain: Schedule
range: string

quickReply
type: Property
domain: Schedule
range: boolean

columnsUsed
type: Property
domain: Schedule

timeSendString
type: Property
domain: Schedule

name
type: Property
domain: Schedule
range: string

created
type: Property
domain: Schedule
range: dateTime

updated
type: Property
domain: Schedule
range: dateTime

audience
type: Property
domain: Schedule
max cardinality: 1
range: Audience

userManages
type: Property
domain: Schedule

totalCampaignUserContacts
type: Property
domain: Schedule
range: integer

Stats
type: Class
title: Stats
supported property: SupportedProperty
  property: ip
  title: ip
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: created
  title: created
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: business
  title: business
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: data
  title: data
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: phone
  title: phone
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: referer
  title: referer
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: country
  title: country
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: note
  title: note
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: callback
  title: callback
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: whatsapp
  title: whatsapp
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: hide
  title: hide
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: contacted
  title: contacted
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: utmParams
  title: utmParams
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: amount
  title: amount
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: utmParamsContact
  title: utmParamsContact
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: dataProperties
  title: dataProperties
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: bookingData
  title: bookingData
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: isLeadNew
  title: isLeadNew
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a Stats resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Stats resource.
  returns: Stats
supported operation: Replaces the Stats resource.
  type: Operation
  type: ReplaceAction
  expects: Stats
  method: PUT
  title: Replaces the Stats resource.
  returns: Stats
supported operation: Deletes the Stats resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Stats resource.
  returns: Nothing

ip
type: Property
domain: Stats
range: string

created
type: Property
domain: Stats
range: dateTime

business
type: Property
domain: Stats
max cardinality: 1
range: Widget

data
type: Property
domain: Stats

phone
type: Property
domain: Stats
range: string

referer
type: Property
domain: Stats
range: string

country
type: Property
domain: Stats
range: string

note
type: Property
domain: Stats
range: string

callback
type: Property
domain: Stats
range: string

whatsapp
type: Property
domain: Stats
max cardinality: 1
range: WhatsappOperator

hide
type: Property
domain: Stats
range: boolean

contacted
type: Property
domain: Stats
range: boolean

utmParams
type: Property
domain: Stats
range: string

amount
type: Property
domain: Stats
range: decimal

utmParamsContact
type: Property
domain: Stats
range: string

dataProperties
type: Property
domain: Stats

bookingData
type: Property
domain: Stats
range: Booking

isLeadNew
type: Property
domain: Stats

User
type: Class
title: User
supported property: SupportedProperty
  property: uuid
  title: uuid
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: email
  title: email
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: roles
  title: roles
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: password
  title: password
  required: false
  readable: true
  writeable: true
  description: The hashed password
supported property: SupportedProperty
  property: businesses
  title: businesses
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: hash
  title: hash
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: hashTime
  title: hashTime
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: enabled
  title: enabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: website
  title: website
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: subscriptions
  title: subscriptions
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: StripeCustommerId
  title: StripeCustommerId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: created
  title: created
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: hubspotKey
  title: hubspotKey
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: hubspots
  title: hubspots
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: businessName
  title: businessName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: phoneCode
  title: phoneCode
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: phoneNumber
  title: phoneNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: bankAccount
  title: bankAccount
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: toc
  title: toc
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: modified
  title: modified
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: alertEntities
  title: alertEntities
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: mailOk
  title: mailOk
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: noMailLink
  title: noMailLink
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: onboard
  title: onboard
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: onboardPaymentLinks
  title: onboardPaymentLinks
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: needHubspot
  title: needHubspot
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: needWhatsappApi
  title: needWhatsappApi
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: landing
  title: landing
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: whiteLabel
  title: whiteLabel
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sellOnline
  title: sellOnline
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: whatsapps
  title: whatsapps
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: managedBy
  title: managedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: manages
  title: manages
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a User resource.
supported operation: Updates the User resource.
supported operation: Deletes the User resource.

uuid
type: Property
domain: User

email
type: Property
domain: User
range: string

roles
type: Property
domain: User

password
type: Property
domain: User
range: string

businesses
type: Link
domain: User
range: Widget

hash
type: Property
domain: User
range: string

hashTime
type: Property
domain: User
range: dateTime

enabled
type: Property
domain: User
range: boolean

website
type: Property
domain: User
range: string

subscriptions
type: Property
domain: User

StripeCustommerId
type: Property
domain: User
range: string

created
type: Property
domain: User
range: dateTime

hubspotKey
type: Property
domain: User
range: string

hubspots
type: Property
domain: User

businessName
type: Property
domain: User
range: string

phoneCode
type: Property
domain: User
range: string

phoneNumber
type: Property
domain: User
range: string

bankAccount
type: Property
domain: User
range: string

toc
type: Property
domain: User
range: boolean

modified
type: Property
domain: User
range: dateTime

alertEntities
type: Property
domain: User

mailOk
type: Property
domain: User
range: boolean

noMailLink
type: Property
domain: User
range: string

onboard
type: Property
domain: User

onboardPaymentLinks
type: Property
domain: User

needHubspot
type: Property
domain: User
range: boolean

needWhatsappApi
type: Property
domain: User
range: boolean

landing
type: Property
domain: User

whiteLabel
type: Property
domain: User

sellOnline
type: Property
domain: User
range: boolean

whatsapps
type: Link
domain: User
range: WhatsappOperator

managedBy
type: Link
domain: User
max cardinality: 1
range: User

manages
type: Link
domain: User
range: User

clientifyKey
type: Property
domain: User
range: string

whatsAppApiConfiguration
type: Property
domain: User

googleAnalytics
type: Property
domain: User
range: string

needClientify
type: Property
domain: User
range: boolean

zohoGeneratedCode
type: Property
domain: User
range: string

zohoClientId
type: Property
domain: User
range: string

zohoClientSecret
type: Property
domain: User
range: string

zohoRefreshCode
type: Property
domain: User
range: string

zohoRegion
type: Property
domain: User
range: string

remoteLogins
type: Property
domain: User

needZoho
type: Property
domain: User
range: boolean

noneOfTheAbove
type: Property
domain: User
range: boolean

businessCategory
type: Property
domain: User

userContacts
type: Link
domain: User
range: UserContact

audiences
type: Link
domain: User
range: Audience

campaigns
type: Link
domain: User
range: Campaign

schedules
type: Link
domain: User
range: Schedule

language
type: Property
domain: User
range: string

lastLogin
type: Property
domain: User
range: dateTime

businessSlug
type: Property
domain: User
range: string

userToMessages
type: Property
domain: User

userFromMessages
type: Property
domain: User

clientStatus
type: Property
domain: User
range: integer

avatarUrl
type: Property
domain: User
range: string

avatar
type: Property
domain: User
range: string

widgetsEditor
type: Link
domain: User
range: Widget

country
type: Property
domain: User
range: string

whatsAppProvider
type: Property
domain: User
range: string

whatsAppApiKey
type: Property
domain: User
range: string

whatsAppApiName
type: Property
domain: User
range: string

whatsAppApiPhoneNumber
type: Property
domain: User
range: string

whatsAppApiId
type: Property
domain: User
range: string

templateNamespace
type: Property
domain: User
range: string

whatsAppWebHookData
type: Property
domain: User

typeIntegration
type: Property
domain: User
range: string

shopFront
type: Property
domain: User
range: boolean

shopSlug
type: Property
domain: User
range: string

myName
type: Property
domain: User
range: string

businessTags
type: Link
domain: User
range: BusinessTag

currency
type: Property
domain: User
range: string

timezone
type: Property
domain: User
range: string

emailConfirmed
type: Property
domain: User
range: boolean

landings
type: Property
domain: User

customization
type: Property
domain: User

adminNote
type: Property
domain: User
range: string

havePhoneNumberWithoutWhatsapp
type: Property
domain: User
range: boolean

haveFacebookId
type: Property
domain: User
range: boolean

apiKeyJsonFile
type: Property
domain: User
range: string

enableApiKeyJsonFile
type: Property
domain: User
range: boolean

facebookPixel
type: Property
domain: User
range: string

acceptTerms
type: Property
domain: User
range: boolean

acceptNewsletter
type: Property
domain: User
range: boolean

acceptNewsletterDate
type: Property
domain: User
range: dateTime

audienceTags
type: Property
domain: User

whatDoYouDo
type: Property
domain: User

utmRegistrationTag
type: Property
domain: User
range: string

forcemanagerPrivateKey
type: Property
domain: User
range: string

forcemanagerPublicKey
type: Property
domain: User
range: string

forceManagerBranch
type: Property
domain: User
range: string

forceManagerUser
type: Property
domain: User
range: string

odooDb
type: Property
domain: User
range: string

odooUser
type: Property
domain: User
range: string

odooPass
type: Property
domain: User
range: string

pipedriveApiToken
type: Property
domain: User
range: string

pipedriveCompanyDomain
type: Property
domain: User
range: string

activeCampaignApiKey
type: Property
domain: User
range: string

activeCampaignAccountName
type: Property
domain: User
range: string

odooCustomDomain
type: Property
domain: User
range: string

manyContactApi
type: Property
domain: User
range: string

hubspotDealStage
type: Property
domain: User
range: string

hubspotPipeline
type: Property
domain: User
range: string

singleSignOns
type: Property
domain: User

salesforceDomain
type: Property
domain: User
range: string

salesforceUsername
type: Property
domain: User
range: string

salesforcePassword
type: Property
domain: User
range: string

salesforceClientId
type: Property
domain: User
range: string

salesforceClientSecret
type: Property
domain: User
range: string

googleTagManager
type: Property
domain: User
range: string

webhookLeadAvailable
type: Property
domain: User
range: boolean

activeMarketplace
type: Property
domain: User
range: boolean

webhookLeadUrl
type: Property
domain: User
range: string

webhookType
type: Property
domain: User
range: string

isBeedigital
type: Property
domain: User
range: boolean

odooType
type: Property
domain: User
range: string

mfa
type: Property
domain: User

webhookAuthKey
type: Property
domain: User
range: string

manyContactEnableForSubAgent
type: Property
domain: User
range: boolean

campaignsEnableForSubAgent
type: Property
domain: User
range: boolean

paymentLinksEnableForSubAgent
type: Property
domain: User
range: boolean

transactionsEnableForSubAgent
type: Property
domain: User
range: boolean

clients
type: Property
domain: User

userZoomIntegration
type: Property
domain: User

businessCouponsSettingAction
type: Property
domain: User
range: string

downloadLeadsEnableForSubAgent
type: Property
domain: User
range: boolean

hideProviders
type: Property
domain: User
range: boolean

marketplaceConfigAgentBigImage
type: Property
domain: User
range: boolean

marketplaceConfigDescription
type: Property
domain: User
range: string

businessFunnels
type: Property
domain: User

landingsNoFollow
type: Property
domain: User
range: boolean

formatDate
type: Property
domain: User
range: string

marketplaceConfigUseWhitelabelColor
type: Property
domain: User
range: boolean

marketplaceConfigCustomCSS
type: Property
domain: User
range: string

bussnessesLeadsToBuy
type: Link
domain: User
range: Widget

marketplaceConfigShowRelatedBusiness
type: Property
domain: User
range: boolean

marketplaceStatsVisits
type: Property
domain: User
range: integer

connectedClients
type: Property
domain: User
range: boolean

enableYourDailyBestLeads
type: Property
domain: User
range: boolean

notifyConnectedClient
type: Property
domain: User
range: boolean

marketplaceConfigTagManager
type: Property
domain: User
range: string

marketplaceConfigWidgetToRegister
type: Link
domain: User
max cardinality: 1
range: Widget

marketplaceConfigEnableWidgetToRegister
type: Property
domain: User
range: boolean

marketplaceConfigWidgetToRegisterText
type: Property
domain: User
range: string

whatsappInboxSecretKey
type: Property
domain: User
range: string

easyWidgetConfiguration
type: Property
domain: User
range: boolean

dudaApiEndpoint
type: Property
domain: User
range: string

duda
type: Property
domain: User
range: boolean

defaultInboxFormAgent
type: Link
domain: User
max cardinality: 1
range: WhatsappOperator

AIType
type: Property
domain: User
range: string

AIAIType
type: Property
domain: User
range: string

AIKey
type: Property
domain: User
range: string

aiMcpServerUrl
type: Property
domain: User
range: string

aiMcpAuthToken
type: Property
domain: User
range: string

encryptDecryptCipher
type: Property
domain: User
range: string

encryptDecryptIv
type: Property
domain: User
range: string

username
type: Property
domain: User
range: string

role
type: Property
domain: User

salt
type: Property
domain: User
range: string

stripeCustommerId
type: Property
domain: User
range: string

alerts
type: Property
domain: User

urlWhatsAppWebHook
type: Property
domain: User
range: string

whatsAppWebHookActive
type: Property
domain: User
range: boolean

typeWhatsappWebhook
type: Property
domain: User
range: string

myInboxWidget
type: Link
domain: User
max cardinality: 1
range: Widget

businessCouponsSettingActionDoNothing
type: Property
domain: User
range: boolean

businessCouponsSettingActionBlocking
type: Property
domain: User
range: boolean

formatDateRangePicker
type: Property
domain: User
range: string

formatDateTwig
type: Property
domain: User
range: string

dudaUuid
type: Property
domain: User
range: string

userIdentifier
type: Property
domain: User
range: string

aIType
type: Property
domain: User
range: string

aIKey
type: Property
domain: User
range: string

id
type: Property
domain: User
range: integer

managedById
type: Property
domain: User
range: integer

UserContact
type: Class
title: UserContact
supported property: SupportedProperty
  property: data
  title: data
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a UserContact resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a UserContact resource.
  returns: Nothing
supported operation: Replaces the UserContact resource.
  type: Operation
  type: ReplaceAction
  expects: UserContact
  method: PUT
  title: Replaces the UserContact resource.
  returns: UserContact

data
type: Property
domain: UserContact

WhatsappOperator
type: Class
title: WhatsappOperator
supported property: SupportedProperty
  property: number
  title: number
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: active
  title: active
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: iconUrl
  title: iconUrl
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: messageFileUrl
  title: messageFileUrl
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: business
  title: business
  required: true
  readable: true
  writeable: false
supported property: SupportedProperty
  property: business_id
  title: business_id
  required: false
  readable: false
  writeable: true
  deprecated: true
supported property: SupportedProperty
  property: post
  title: post
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: message
  title: message
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sequence
  title: sequence
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: form
  title: form
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: emailSubjectForLeads
  title: emailSubjectForLeads
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: manager
  title: manager
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: chatform
  title: chatform
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: activateDirectlyChat
  title: activateDirectlyChat
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: numberLink
  title: numberLink
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: noWhatsappRedirect
  title: noWhatsappRedirect
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: aiChatFaq
  title: aiChatFaq
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sendWebhookLead
  title: sendWebhookLead
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: formBeforeFaqs
  title: formBeforeFaqs
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a WhatsappOperator resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a WhatsappOperator resource.
  returns: WhatsappOperator
supported operation: Replaces the WhatsappOperator resource.
  type: Operation
  type: ReplaceAction
  expects: WhatsappOperator
  method: PUT
  title: Replaces the WhatsappOperator resource.
  returns: WhatsappOperator
supported operation: Replaces the WhatsappOperator resource.
  type: Operation
  type: ReplaceAction
  expects: WhatsappOperator
  method: PUT
  title: Replaces the WhatsappOperator resource.
  returns: WhatsappOperator
supported operation: Deletes the WhatsappOperator resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the WhatsappOperator resource.
  returns: Nothing

number
type: Property
domain: WhatsappOperator
range: string

name
type: Property
domain: WhatsappOperator
range: string

active
type: Property
domain: WhatsappOperator
range: boolean

iconUrl
type: Property
domain: WhatsappOperator
range: string

messageFileUrl
type: Property
domain: WhatsappOperator
range: string

business
type: Property
domain: WhatsappOperator
max cardinality: 1
range: Widget

business_id
type: Property
domain: WhatsappOperator

post
type: Property
domain: WhatsappOperator
range: string

message
type: Property
domain: WhatsappOperator
range: string

sequence
type: Property
domain: WhatsappOperator
range: integer

form
type: Property
domain: WhatsappOperator

email
type: Property
domain: WhatsappOperator
range: string

emailSubjectForLeads
type: Property
domain: WhatsappOperator
range: string

manager
type: Link
domain: WhatsappOperator
max cardinality: 1
range: User

chatform
type: Property
domain: WhatsappOperator
range: boolean

activateDirectlyChat
type: Property
domain: WhatsappOperator
range: boolean

numberLink
type: Property
domain: WhatsappOperator
range: string

noWhatsappRedirect
type: Property
domain: WhatsappOperator
range: boolean

aiChatFaq
type: Property
domain: WhatsappOperator
range: boolean

sendWebhookLead
type: Property
domain: WhatsappOperator
range: boolean

formBeforeFaqs
type: Property
domain: WhatsappOperator
range: boolean

WhatsappTemplate
type: Class
title: WhatsappTemplate
supported property: SupportedProperty
  property: bodyReplaced
  title: bodyReplaced
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: headerReplaced
  title: headerReplaced
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: placeholders
  title: placeholders
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: placeholdersHeader
  title: placeholdersHeader
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: buttonsReplaced
  title: buttonsReplaced
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: clientParameters
  title: clientParameters
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: clientParametersHeader
  title: clientParametersHeader
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: language
  title: language
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: data
  title: data
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: header
  title: header
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: body
  title: body
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: footer
  title: footer
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: parameters
  title: parameters
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: buttons
  title: buttons
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: parametersHeader
  title: parametersHeader
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a WhatsappTemplate resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a WhatsappTemplate resource.
  returns: Nothing

bodyReplaced
type: Property
domain: WhatsappTemplate
range: string

headerReplaced
type: Property
domain: WhatsappTemplate
range: string

placeholders
type: Property
domain: WhatsappTemplate

placeholdersHeader
type: Property
domain: WhatsappTemplate

buttonsReplaced
type: Property
domain: WhatsappTemplate

clientParameters
type: Property
domain: WhatsappTemplate

clientParametersHeader
type: Property
domain: WhatsappTemplate

id
type: Property
domain: WhatsappTemplate
range: string

name
type: Property
domain: WhatsappTemplate
range: string

language
type: Property
domain: WhatsappTemplate
range: string

status
type: Property
domain: WhatsappTemplate
range: string

data
type: Property
domain: WhatsappTemplate

header
type: Property
domain: WhatsappTemplate

body
type: Property
domain: WhatsappTemplate
range: string

footer
type: Property
domain: WhatsappTemplate
range: string

parameters
type: Property
domain: WhatsappTemplate

buttons
type: Property
domain: WhatsappTemplate

parametersHeader
type: Property
domain: WhatsappTemplate

WidgetServiceIdStats
type: Class
title: WidgetServiceIdStats
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: clicksLastDay
  title: clicksLastDay
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: clicksLastWeek
  title: clicksLastWeek
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: clicksLastMonth
  title: clicksLastMonth
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: clicksLastYear
  title: clicksLastYear
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: clicksAll
  title: clicksAll
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a WidgetServiceIdStats resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a WidgetServiceIdStats resource.
  returns: WidgetServiceIdStats

id
type: Property
domain: WidgetServiceIdStats

clicksLastDay
type: Property
domain: WidgetServiceIdStats
range: integer

clicksLastWeek
type: Property
domain: WidgetServiceIdStats
range: integer

clicksLastMonth
type: Property
domain: WidgetServiceIdStats
range: integer

clicksLastYear
type: Property
domain: WidgetServiceIdStats
range: integer

clicksAll
type: Property
domain: WidgetServiceIdStats
range: integer

WidgetStats
type: Class
title: WidgetStats
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: clicksLastDay
  title: clicksLastDay
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: clicksLastWeek
  title: clicksLastWeek
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: clicksLastMonth
  title: clicksLastMonth
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: clicksLastYear
  title: clicksLastYear
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: clicksAll
  title: clicksAll
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: clicksLastDayWebsite
  title: clicksLastDayWebsite
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: clicksLastWeekWebsite
  title: clicksLastWeekWebsite
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: clicksLastMonthWebsite
  title: clicksLastMonthWebsite
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: clicksLastYearWebsite
  title: clicksLastYearWebsite
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: clicksAllWebsite
  title: clicksAllWebsite
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: clicksLastDayGoogle
  title: clicksLastDayGoogle
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: clicksLastWeekGoogle
  title: clicksLastWeekGoogle
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: clicksLastMonthGoogle
  title: clicksLastMonthGoogle
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: clicksLastYearGoogle
  title: clicksLastYearGoogle
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: clicksAllGoogle
  title: clicksAllGoogle
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a WidgetStats resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a WidgetStats resource.
  returns: WidgetStats

id
type: Property
domain: WidgetStats

clicksLastDay
type: Property
domain: WidgetStats
range: integer

clicksLastWeek
type: Property
domain: WidgetStats
range: integer

clicksLastMonth
type: Property
domain: WidgetStats
range: integer

clicksLastYear
type: Property
domain: WidgetStats
range: integer

clicksAll
type: Property
domain: WidgetStats
range: integer

clicksLastDayWebsite
type: Property
domain: WidgetStats
range: integer

clicksLastWeekWebsite
type: Property
domain: WidgetStats
range: integer

clicksLastMonthWebsite
type: Property
domain: WidgetStats
range: integer

clicksLastYearWebsite
type: Property
domain: WidgetStats
range: integer

clicksAllWebsite
type: Property
domain: WidgetStats
range: integer

clicksLastDayGoogle
type: Property
domain: WidgetStats
range: integer

clicksLastWeekGoogle
type: Property
domain: WidgetStats
range: integer

clicksLastMonthGoogle
type: Property
domain: WidgetStats
range: integer

clicksLastYearGoogle
type: Property
domain: WidgetStats
range: integer

clicksAllGoogle
type: Property
domain: WidgetStats
range: integer

Entrypoint
type: Class
title: The API entrypoint
supported property: SupportedProperty
  property: The collection of ActiveUser resources
  title: The collection of ActiveUser resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Anniversary resources
  title: The collection of Anniversary resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of AnniversaryMessage resources
  title: The collection of AnniversaryMessage resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Audience resources
  title: The collection of Audience resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of AudienceFiltered resources
  title: The collection of AudienceFiltered resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of BackgroundFile resources
  title: The collection of BackgroundFile resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of BookingConfig resources
  title: The collection of BookingConfig resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Widget resources
  title: The collection of Widget resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of GoogleFeed resources
  title: The collection of GoogleFeed resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of BusinessTag resources
  title: The collection of BusinessTag resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Campaign resources
  title: The collection of Campaign resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of CampaignUserContact resources
  title: The collection of CampaignUserContact resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of FaqGrp resources
  title: The collection of FaqGrp resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of FreeBookingCategory resources
  title: The collection of FreeBookingCategory resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of FreeBookingEvent resources
  title: The collection of FreeBookingEvent resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of FreeBookingField resources
  title: The collection of FreeBookingField resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Schedule resources
  title: The collection of Schedule resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Stats resources
  title: The collection of Stats resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of User resources
  title: The collection of User resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of UserContact resources
  title: The collection of UserContact resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of WhatsappOperator resources
  title: The collection of WhatsappOperator resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of WhatsappTemplate resources
  title: The collection of WhatsappTemplate resources
  readable: true
  writeable: false
supported operation: The API entrypoint.
  type: Operation
  method: GET
  returns: EntryPoint

The collection of ActiveUser resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ActiveUser
supported operation: Creates a ActiveUser resource.
  type: Operation
  type: CreateAction
  expects: ActiveUser
  method: POST
  title: Creates a ActiveUser resource.
  returns: Nothing

The collection of Anniversary resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Anniversary
supported operation: Retrieves the collection of Anniversary resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Anniversary resources.
  returns: Collection
supported operation: Creates a Anniversary resource.
  type: Operation
  type: CreateAction
  expects: Anniversary
  method: POST
  title: Creates a Anniversary resource.
  returns: Anniversary

The collection of AnniversaryMessage resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: AnniversaryMessage
supported operation: Retrieves the collection of AnniversaryMessage resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of AnniversaryMessage resources.
  returns: Collection

The collection of Audience resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Audience
supported operation: Retrieves the collection of Audience resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Audience resources.
  returns: Collection
supported operation: Creates a Audience resource.
  type: Operation
  type: CreateAction
  expects: Audience
  method: POST
  title: Creates a Audience resource.
  returns: Audience

The collection of AudienceFiltered resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: AudienceFiltered
supported operation: Creates a AudienceFiltered resource.
  type: Operation
  type: CreateAction
  expects: AudienceFiltered
  method: POST
  title: Creates a AudienceFiltered resource.
  returns: AudienceFiltered

The collection of BackgroundFile resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: BackgroundFile
supported operation: Retrieves the collection of BackgroundFile resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of BackgroundFile resources.
  returns: Collection

The collection of BookingConfig resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: BookingConfig
supported operation: Retrieves the collection of BookingConfig resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of BookingConfig resources.
  returns: Collection
supported operation: Creates a BookingConfig resource.
  type: Operation
  type: CreateAction
  expects: BookingConfig
  method: POST
  title: Creates a BookingConfig resource.
  returns: BookingConfig
supported operation: Retrieves the collection of WhatsappOperator resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of WhatsappOperator resources.
  returns: Collection

The collection of Widget resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Widget
supported operation: Retrieves the collection of Widget resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Widget resources.
  returns: Collection
supported operation: Creates a Widget resource.
  type: Operation
  type: CreateAction
  expects: Widget
  method: POST
  title: Creates a Widget resource.
  returns: Widget

The collection of GoogleFeed resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: GoogleFeed
supported operation: Retrieves the collection of GoogleFeed resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of GoogleFeed resources.
  returns: Collection
supported operation: Creates a GoogleFeed resource.
  type: Operation
  type: CreateAction
  expects: GoogleFeed
  method: POST
  title: Creates a GoogleFeed resource.
  returns: GoogleFeed

The collection of BusinessTag resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: BusinessTag
supported operation: Retrieves the collection of BusinessTag resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of BusinessTag resources.
  returns: Collection

The collection of Campaign resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Campaign
supported operation: Retrieves the collection of Campaign resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Campaign resources.
  returns: Collection
supported operation: Creates a Campaign resource.
  type: Operation
  type: CreateAction
  expects: Campaign
  method: POST
  title: Creates a Campaign resource.
  returns: Campaign

The collection of CampaignUserContact resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: CampaignUserContact
supported operation: Retrieves the collection of CampaignUserContact resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of CampaignUserContact resources.
  returns: Collection
supported operation: Retrieves the collection of CampaignUserContact resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of CampaignUserContact resources.
  returns: Collection

The collection of FaqGrp resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: FaqGrp
supported operation: Creates a FaqGrp resource.
  type: Operation
  type: CreateAction
  expects: FaqGrp
  method: POST
  title: Creates a FaqGrp resource.
  returns: FaqGrp
supported operation: Retrieves the collection of WhatsappOperator resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of WhatsappOperator resources.
  returns: Collection

The collection of FreeBookingCategory resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: FreeBookingCategory
supported operation: Retrieves the collection of FreeBookingCategory resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of FreeBookingCategory resources.
  returns: Collection

The collection of FreeBookingEvent resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: FreeBookingEvent
supported operation: Retrieves the collection of FreeBookingEvent resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of FreeBookingEvent resources.
  returns: Collection

The collection of FreeBookingField resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: FreeBookingField
supported operation: Retrieves the collection of FreeBookingField resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of FreeBookingField resources.
  returns: Collection
supported operation: Creates a FreeBookingField resource.
  type: Operation
  type: CreateAction
  expects: FreeBookingField
  method: POST
  title: Creates a FreeBookingField resource.
  returns: FreeBookingField

The collection of Schedule resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Schedule
supported operation: Retrieves the collection of Schedule resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Schedule resources.
  returns: Collection
supported operation: Creates a Schedule resource.
  type: Operation
  type: CreateAction
  expects: Schedule
  method: POST
  title: Creates a Schedule resource.
  returns: Schedule

The collection of Stats resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Stats
supported operation: Retrieves the collection of Stats resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Stats resources.
  returns: Collection

The collection of User resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: User
supported operation: Retrieves the collection of User resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of User resources.
  returns: Collection
supported operation: Creates a User resource.
  type: Operation
  type: CreateAction
  expects: User
  method: POST
  title: Creates a User resource.
  returns: User
supported operation: Creates a User resource.
  type: Operation
  type: CreateAction
  expects: User
  method: POST
  title: Creates a User resource.
  returns: Nothing
supported operation: Creates a User resource.
  type: Operation
  type: CreateAction
  expects: Nothing
  method: POST
  title: Creates a User resource.
  returns: Nothing

The collection of UserContact resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: UserContact
supported operation: Retrieves the collection of UserContact resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of UserContact resources.
  returns: Collection
supported operation: Retrieves the collection of UserContact resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of UserContact resources.
  returns: Collection
supported operation: Creates a UserContact resource.
  type: Operation
  type: CreateAction
  expects: UserContact
  method: POST
  title: Creates a UserContact resource.
  returns: Nothing
supported operation: Retrieves the collection of Audience resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Audience resources.
  returns: Collection

The collection of WhatsappOperator resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: WhatsappOperator
supported operation: Retrieves the collection of WhatsappOperator resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of WhatsappOperator resources.
  returns: Collection
supported operation: Creates a WhatsappOperator resource.
  type: Operation
  type: CreateAction
  expects: WhatsappOperator
  method: POST
  title: Creates a WhatsappOperator resource.
  returns: WhatsappOperator

The collection of WhatsappTemplate resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: WhatsappTemplate
supported operation: Retrieves the collection of WhatsappTemplate resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of WhatsappTemplate resources.
  returns: Collection

ConstraintViolation
type: Class
title: A constraint violation
supported property: SupportedProperty
  property: propertyPath
  title: propertyPath
  description: The property path of the violation
  readable: true
  writeable: false
supported property: SupportedProperty
  property: message
  title: message
  description: The message associated with the violation
  readable: true
  writeable: false

propertyPath
type: Property
domain: ConstraintViolation
range: string

message
type: Property
domain: ConstraintViolation
range: string

ConstraintViolationList
type: Class
subclass of: Error
title: A constraint violation list
supported property: SupportedProperty
  property: violations
  title: violations
  description: The violations
  readable: true
  writeable: false

violations
type: Property
domain: ConstraintViolationList
range: ConstraintViolation

Deletes the BookingConfig resource.
type: Operation
type: DeleteAction
method: DELETE
title: Deletes the BookingConfig resource.
returns: Nothing

SupportedProperty
property: landingShowQR
title: landingShowQR
required: false
readable: true
writeable: false

SupportedProperty
property: faqsChatBotQuestionText
title: faqsChatBotQuestionText
required: false
readable: true
writeable: true

SupportedProperty
property: faqsChatBotNotSolvedText
title: faqsChatBotNotSolvedText
required: false
readable: true
writeable: true

SupportedProperty
property: translateOnlineFrom
title: translateOnlineFrom
required: false
readable: true
writeable: true

SupportedProperty
property: translateShowTimetable
title: translateShowTimetable
required: false
readable: true
writeable: true

SupportedProperty
property: userClient
title: userClient
required: false
readable: true
writeable: true

SupportedProperty
property: transSuccessMessage
title: transSuccessMessage
required: false
readable: true
writeable: true

SupportedProperty
property: defaultLanguage
title: defaultLanguage
required: false
readable: true
writeable: true

SupportedProperty
property: landingFacebookPixel
title: landingFacebookPixel
required: false
readable: true
writeable: false

SupportedProperty
property: landingGoogleAnalytics
title: landingGoogleAnalytics
required: false
readable: true
writeable: false

SupportedProperty
property: landingGoogleTagManager
title: landingGoogleTagManager
required: false
readable: true
writeable: false

SupportedProperty
property: landingGetconver
title: landingGetconver
required: false
readable: true
writeable: false

SupportedProperty
property: businessTags
title: businessTags
required: false
readable: true
writeable: true

SupportedProperty
property: cookiesDescription
title: cookiesDescription
required: false
readable: true
writeable: true

SupportedProperty
property: cookiesTitle
title: cookiesTitle
required: false
readable: true
writeable: true

SupportedProperty
property: translateChatAnswer
title: translateChatAnswer
required: false
readable: true
writeable: true

SupportedProperty
property: enableCookieBanner
title: enableCookieBanner
required: false
readable: true
writeable: true

SupportedProperty
property: haltBusiness
title: haltBusiness
required: false
readable: true
writeable: true

SupportedProperty
property: landingPrivacy
title: landingPrivacy
required: false
readable: true
writeable: true

SupportedProperty
property: landingTermsAndConditions
title: landingTermsAndConditions
required: false
readable: true
writeable: true

SupportedProperty
property: alliance
title: alliance
required: false
readable: true
writeable: true

SupportedProperty
property: landingTel
title: landingTel
required: false
readable: true
writeable: true

SupportedProperty
property: landingAddress
title: landingAddress
required: false
readable: true
writeable: true

SupportedProperty
property: landingExtraText
title: landingExtraText
required: false
readable: true
writeable: false

SupportedProperty
property: removeSocialSharing
title: removeSocialSharing
required: false
readable: true
writeable: false

SupportedProperty
property: landingShowYoutubeVideo
title: landingShowYoutubeVideo
required: false
readable: true
writeable: true

SupportedProperty
property: landingYoutubeVideo
title: landingYoutubeVideo
required: false
readable: true
writeable: true

SupportedProperty
property: customCss
title: customCss
required: false
readable: true
writeable: true

SupportedProperty
property: saveDataInWidget
title: saveDataInWidget
required: false
readable: true
writeable: true

SupportedProperty
property: landingShowGalleryImages
title: landingShowGalleryImages
required: false
readable: true
writeable: true

SupportedProperty
property: landingGalleryImages
title: landingGalleryImages
required: false
readable: true
writeable: true

SupportedProperty
property: noFollow
title: noFollow
required: false
readable: true
writeable: true

SupportedProperty
property: showBrandInWidget
title: showBrandInWidget
required: false
readable: true
writeable: true

SupportedProperty
property: keepBannerWithFormNewUser
title: keepBannerWithFormNewUser
required: false
readable: true
writeable: true

SupportedProperty
property: keepBannerWithFormOldUser
title: keepBannerWithFormOldUser
required: false
readable: true
writeable: true

SupportedProperty
property: translateChatWithAgent
title: translateChatWithAgent
required: false
readable: true
writeable: true

SupportedProperty
property: landingShowWhatsappAnchorOnMobile
title: landingShowWhatsappAnchorOnMobile
required: false
readable: true
writeable: true

SupportedProperty
property: extraLinksFirst
title: extraLinksFirst
required: false
readable: true
writeable: true

SupportedProperty
property: hideExtraLinksOnMobile
title: hideExtraLinksOnMobile
required: false
readable: true
writeable: true

SupportedProperty
property: hideExtraLinksOnDesktop
title: hideExtraLinksOnDesktop
required: false
readable: true
writeable: true

SupportedProperty
property: pinInMarketplace
title: pinInMarketplace
required: false
readable: true
writeable: true

SupportedProperty
property: landingShowVCard
title: landingShowVCard
required: false
readable: true
writeable: true

SupportedProperty
property: easyWidgetConfiguration
title: easyWidgetConfiguration
required: false
readable: true
writeable: true

Retrieves a Widget resource.
type: Operation
type: FindAction
method: GET
title: Retrieves a Widget resource.
returns: Widget

Replaces the Widget resource.
type: Operation
type: ReplaceAction
expects: Widget
method: PUT
title: Replaces the Widget resource.
returns: Widget

Updates the Widget resource.
type: Operation
expects: Widget
method: PATCH
title: Updates the Widget resource.
returns: Widget

Deletes the Widget resource.
type: Operation
type: DeleteAction
method: DELETE
title: Deletes the Widget resource.
returns: Nothing

SupportedProperty
property: userManages
title: userManages
required: false
readable: true
writeable: true

SupportedProperty
property: totalCampaignUserContacts
title: totalCampaignUserContacts
required: false
readable: true
writeable: false

Retrieves a Schedule resource.
type: Operation
type: FindAction
method: GET
title: Retrieves a Schedule resource.
returns: Schedule

Replaces the Schedule resource.
type: Operation
type: ReplaceAction
expects: Schedule
method: PUT
title: Replaces the Schedule resource.
returns: Schedule

Replaces the Schedule resource.
type: Operation
type: ReplaceAction
expects: Schedule
method: PUT
title: Replaces the Schedule resource.
returns: Nothing

Replaces the Schedule resource.
type: Operation
type: ReplaceAction
expects: Schedule
method: PUT
title: Replaces the Schedule resource.
returns: Nothing

Deletes the Schedule resource.
type: Operation
type: DeleteAction
method: DELETE
title: Deletes the Schedule resource.
returns: Nothing

SupportedProperty
property: clientifyKey
title: clientifyKey
required: false
readable: true
writeable: true

SupportedProperty
property: whatsAppApiConfiguration
title: whatsAppApiConfiguration
required: false
readable: true
writeable: true

SupportedProperty
property: googleAnalytics
title: googleAnalytics
required: false
readable: true
writeable: true

SupportedProperty
property: needClientify
title: needClientify
required: false
readable: true
writeable: true

SupportedProperty
property: zohoGeneratedCode
title: zohoGeneratedCode
required: false
readable: true
writeable: true

SupportedProperty
property: zohoClientId
title: zohoClientId
required: false
readable: true
writeable: true

SupportedProperty
property: zohoClientSecret
title: zohoClientSecret
required: false
readable: true
writeable: true

SupportedProperty
property: zohoRefreshCode
title: zohoRefreshCode
required: false
readable: true
writeable: true

SupportedProperty
property: zohoRegion
title: zohoRegion
required: false
readable: true
writeable: true

SupportedProperty
property: remoteLogins
title: remoteLogins
required: false
readable: true
writeable: true

SupportedProperty
property: needZoho
title: needZoho
required: false
readable: true
writeable: true

SupportedProperty
property: noneOfTheAbove
title: noneOfTheAbove
required: false
readable: true
writeable: true

SupportedProperty
property: businessCategory
title: businessCategory
required: false
readable: true
writeable: true

SupportedProperty
property: userContacts
title: userContacts
required: false
readable: true
writeable: true

SupportedProperty
property: audiences
title: audiences
required: false
readable: true
writeable: true

SupportedProperty
property: campaigns
title: campaigns
required: false
readable: true
writeable: true

SupportedProperty
property: schedules
title: schedules
required: false
readable: true
writeable: true

SupportedProperty
property: language
title: language
required: false
readable: true
writeable: true

SupportedProperty
property: lastLogin
title: lastLogin
required: false
readable: true
writeable: true

SupportedProperty
property: businessSlug
title: businessSlug
required: false
readable: true
writeable: true

SupportedProperty
property: userToMessages
title: userToMessages
required: false
readable: true
writeable: false

SupportedProperty
property: userFromMessages
title: userFromMessages
required: false
readable: true
writeable: false

SupportedProperty
property: clientStatus
title: clientStatus
required: false
readable: true
writeable: true

SupportedProperty
property: avatarUrl
title: avatarUrl
required: false
readable: true
writeable: true

SupportedProperty
property: avatar
title: avatar
required: false
readable: true
writeable: true

SupportedProperty
property: widgetsEditor
title: widgetsEditor
required: false
readable: true
writeable: true

SupportedProperty
property: country
title: country
required: false
readable: true
writeable: true

SupportedProperty
property: whatsAppProvider
title: whatsAppProvider
required: false
readable: true
writeable: true

SupportedProperty
property: whatsAppApiKey
title: whatsAppApiKey
required: false
readable: true
writeable: true

SupportedProperty
property: whatsAppApiName
title: whatsAppApiName
required: false
readable: true
writeable: true

SupportedProperty
property: whatsAppApiPhoneNumber
title: whatsAppApiPhoneNumber
required: false
readable: true
writeable: true

SupportedProperty
property: whatsAppApiId
title: whatsAppApiId
required: false
readable: true
writeable: true

SupportedProperty
property: templateNamespace
title: templateNamespace
required: false
readable: true
writeable: true

SupportedProperty
property: whatsAppWebHookData
title: whatsAppWebHookData
required: false
readable: true
writeable: true

SupportedProperty
property: typeIntegration
title: typeIntegration
required: false
readable: true
writeable: true

SupportedProperty
property: shopFront
title: shopFront
required: false
readable: true
writeable: true

SupportedProperty
property: shopSlug
title: shopSlug
required: false
readable: true
writeable: true

SupportedProperty
property: myName
title: myName
required: false
readable: true
writeable: true

SupportedProperty
property: businessTags
title: businessTags
required: false
readable: true
writeable: true

SupportedProperty
property: currency
title: currency
required: false
readable: true
writeable: true

SupportedProperty
property: timezone
title: timezone
required: false
readable: true
writeable: true

SupportedProperty
property: emailConfirmed
title: emailConfirmed
required: false
readable: true
writeable: true

SupportedProperty
property: landings
title: landings
required: false
readable: true
writeable: true

SupportedProperty
property: customization
title: customization
required: false
readable: true
writeable: true

SupportedProperty
property: adminNote
title: adminNote
required: false
readable: true
writeable: true

SupportedProperty
property: havePhoneNumberWithoutWhatsapp
title: havePhoneNumberWithoutWhatsapp
required: false
readable: true
writeable: true

SupportedProperty
property: haveFacebookId
title: haveFacebookId
required: false
readable: true
writeable: true

SupportedProperty
property: apiKeyJsonFile
title: apiKeyJsonFile
required: false
readable: true
writeable: true

SupportedProperty
property: enableApiKeyJsonFile
title: enableApiKeyJsonFile
required: false
readable: true
writeable: true

SupportedProperty
property: facebookPixel
title: facebookPixel
required: false
readable: true
writeable: true

SupportedProperty
property: acceptTerms
title: acceptTerms
required: false
readable: true
writeable: true

SupportedProperty
property: acceptNewsletter
title: acceptNewsletter
required: false
readable: true
writeable: true

SupportedProperty
property: acceptNewsletterDate
title: acceptNewsletterDate
required: false
readable: true
writeable: true

SupportedProperty
property: audienceTags
title: audienceTags
required: false
readable: true
writeable: true

SupportedProperty
property: whatDoYouDo
title: whatDoYouDo
required: false
readable: true
writeable: true

SupportedProperty
property: utmRegistrationTag
title: utmRegistrationTag
required: false
readable: true
writeable: true

SupportedProperty
property: forcemanagerPrivateKey
title: forcemanagerPrivateKey
required: false
readable: true
writeable: true

SupportedProperty
property: forcemanagerPublicKey
title: forcemanagerPublicKey
required: false
readable: true
writeable: true

SupportedProperty
property: forceManagerBranch
title: forceManagerBranch
required: false
readable: true
writeable: true

SupportedProperty
property: forceManagerUser
title: forceManagerUser
required: false
readable: true
writeable: true

SupportedProperty
property: odooDb
title: odooDb
required: false
readable: true
writeable: true

SupportedProperty
property: odooUser
title: odooUser
required: false
readable: true
writeable: true

SupportedProperty
property: odooPass
title: odooPass
required: false
readable: true
writeable: true

SupportedProperty
property: pipedriveApiToken
title: pipedriveApiToken
required: false
readable: true
writeable: true

SupportedProperty
property: pipedriveCompanyDomain
title: pipedriveCompanyDomain
required: false
readable: true
writeable: true

SupportedProperty
property: activeCampaignApiKey
title: activeCampaignApiKey
required: false
readable: true
writeable: true

SupportedProperty
property: activeCampaignAccountName
title: activeCampaignAccountName
required: false
readable: true
writeable: true

SupportedProperty
property: odooCustomDomain
title: odooCustomDomain
required: false
readable: true
writeable: true

SupportedProperty
property: manyContactApi
title: manyContactApi
required: false
readable: true
writeable: true

SupportedProperty
property: hubspotDealStage
title: hubspotDealStage
required: false
readable: true
writeable: true

SupportedProperty
property: hubspotPipeline
title: hubspotPipeline
required: false
readable: true
writeable: true

SupportedProperty
property: singleSignOns
title: singleSignOns
required: false
readable: true
writeable: true

SupportedProperty
property: salesforceDomain
title: salesforceDomain
required: false
readable: true
writeable: true

SupportedProperty
property: salesforceUsername
title: salesforceUsername
required: false
readable: true
writeable: true

SupportedProperty
property: salesforcePassword
title: salesforcePassword
required: false
readable: true
writeable: true

SupportedProperty
property: salesforceClientId
title: salesforceClientId
required: false
readable: true
writeable: true

SupportedProperty
property: salesforceClientSecret
title: salesforceClientSecret
required: false
readable: true
writeable: true

SupportedProperty
property: googleTagManager
title: googleTagManager
required: false
readable: true
writeable: true

SupportedProperty
property: webhookLeadAvailable
title: webhookLeadAvailable
required: false
readable: true
writeable: true

SupportedProperty
property: activeMarketplace
title: activeMarketplace
required: false
readable: true
writeable: true

SupportedProperty
property: webhookLeadUrl
title: webhookLeadUrl
required: false
readable: true
writeable: true

SupportedProperty
property: webhookType
title: webhookType
required: false
readable: true
writeable: true

SupportedProperty
property: isBeedigital
title: isBeedigital
required: false
readable: true
writeable: true

SupportedProperty
property: odooType
title: odooType
required: false
readable: true
writeable: true

SupportedProperty
property: mfa
title: mfa
required: false
readable: true
writeable: true

SupportedProperty
property: webhookAuthKey
title: webhookAuthKey
required: false
readable: true
writeable: true

SupportedProperty
property: manyContactEnableForSubAgent
title: manyContactEnableForSubAgent
required: false
readable: true
writeable: true

SupportedProperty
property: campaignsEnableForSubAgent
title: campaignsEnableForSubAgent
required: false
readable: true
writeable: true

SupportedProperty
property: paymentLinksEnableForSubAgent
title: paymentLinksEnableForSubAgent
required: false
readable: true
writeable: true

SupportedProperty
property: transactionsEnableForSubAgent
title: transactionsEnableForSubAgent
required: false
readable: true
writeable: true

SupportedProperty
property: clients
title: clients
required: false
readable: true
writeable: true

SupportedProperty
property: userZoomIntegration
title: userZoomIntegration
required: false
readable: true
writeable: true

SupportedProperty
property: businessCouponsSettingAction
title: businessCouponsSettingAction
required: false
readable: true
writeable: true

SupportedProperty
property: downloadLeadsEnableForSubAgent
title: downloadLeadsEnableForSubAgent
required: false
readable: true
writeable: true

SupportedProperty
property: hideProviders
title: hideProviders
required: false
readable: true
writeable: true

SupportedProperty
property: marketplaceConfigAgentBigImage
title: marketplaceConfigAgentBigImage
required: false
readable: true
writeable: true

SupportedProperty
property: marketplaceConfigDescription
title: marketplaceConfigDescription
required: false
readable: true
writeable: true

SupportedProperty
property: businessFunnels
title: businessFunnels
required: false
readable: true
writeable: true

SupportedProperty
property: landingsNoFollow
title: landingsNoFollow
required: false
readable: true
writeable: true

SupportedProperty
property: formatDate
title: formatDate
required: false
readable: true
writeable: true

SupportedProperty
property: marketplaceConfigUseWhitelabelColor
title: marketplaceConfigUseWhitelabelColor
required: false
readable: true
writeable: true

SupportedProperty
property: marketplaceConfigCustomCSS
title: marketplaceConfigCustomCSS
required: false
readable: true
writeable: true

SupportedProperty
property: bussnessesLeadsToBuy
title: bussnessesLeadsToBuy
required: false
readable: true
writeable: true

SupportedProperty
property: marketplaceConfigShowRelatedBusiness
title: marketplaceConfigShowRelatedBusiness
required: false
readable: true
writeable: true

SupportedProperty
property: marketplaceStatsVisits
title: marketplaceStatsVisits
required: false
readable: true
writeable: true

SupportedProperty
property: connectedClients
title: connectedClients
required: false
readable: true
writeable: true

SupportedProperty
property: enableYourDailyBestLeads
title: enableYourDailyBestLeads
required: false
readable: true
writeable: true

SupportedProperty
property: notifyConnectedClient
title: notifyConnectedClient
required: false
readable: true
writeable: true

SupportedProperty
property: marketplaceConfigTagManager
title: marketplaceConfigTagManager
required: false
readable: true
writeable: true

SupportedProperty
property: marketplaceConfigWidgetToRegister
title: marketplaceConfigWidgetToRegister
required: false
readable: true
writeable: true

SupportedProperty
property: marketplaceConfigEnableWidgetToRegister
title: marketplaceConfigEnableWidgetToRegister
required: false
readable: true
writeable: true

SupportedProperty
property: marketplaceConfigWidgetToRegisterText
title: marketplaceConfigWidgetToRegisterText
required: false
readable: true
writeable: true

SupportedProperty
property: whatsappInboxSecretKey
title: whatsappInboxSecretKey
required: false
readable: true
writeable: true

SupportedProperty
property: easyWidgetConfiguration
title: easyWidgetConfiguration
required: false
readable: true
writeable: true

SupportedProperty
property: dudaApiEndpoint
title: dudaApiEndpoint
required: false
readable: false
writeable: false

SupportedProperty
property: duda
title: duda
required: false
readable: true
writeable: true

SupportedProperty
property: defaultInboxFormAgent
title: defaultInboxFormAgent
required: false
readable: true
writeable: true

SupportedProperty
property: AIType
title: AIType
required: false
readable: true
writeable: true

SupportedProperty
property: AIAIType
title: AIAIType
required: false
readable: false
writeable: false

SupportedProperty
property: AIKey
title: AIKey
required: false
readable: true
writeable: true

SupportedProperty
property: aiMcpServerUrl
title: aiMcpServerUrl
required: false
readable: true
writeable: true

SupportedProperty
property: aiMcpAuthToken
title: aiMcpAuthToken
required: false
readable: true
writeable: true

SupportedProperty
property: encryptDecryptCipher
title: encryptDecryptCipher
required: false
readable: false
writeable: false

SupportedProperty
property: encryptDecryptIv
title: encryptDecryptIv
required: false
readable: false
writeable: false

SupportedProperty
property: username
title: username
required: false
readable: true
writeable: false
description: A visual identifier that represents this user.

SupportedProperty
property: role
title: role
required: false
readable: false
writeable: false

SupportedProperty
property: salt
title: salt
required: false
readable: true
writeable: false

SupportedProperty
property: stripeCustommerId
title: stripeCustommerId
required: false
readable: true
writeable: true

SupportedProperty
property: alerts
title: alerts
required: false
readable: true
writeable: true

SupportedProperty
property: urlWhatsAppWebHook
title: urlWhatsAppWebHook
required: false
readable: true
writeable: false

SupportedProperty
property: whatsAppWebHookActive
title: whatsAppWebHookActive
required: false
readable: true
writeable: false

SupportedProperty
property: typeWhatsappWebhook
title: typeWhatsappWebhook
required: false
readable: true
writeable: false

SupportedProperty
property: myInboxWidget
title: myInboxWidget
required: false
readable: true
writeable: false

SupportedProperty
property: businessCouponsSettingActionDoNothing
title: businessCouponsSettingActionDoNothing
required: false
readable: true
writeable: false

SupportedProperty
property: businessCouponsSettingActionBlocking
title: businessCouponsSettingActionBlocking
required: false
readable: true
writeable: false

SupportedProperty
property: formatDateRangePicker
title: formatDateRangePicker
required: false
readable: true
writeable: false

SupportedProperty
property: formatDateTwig
title: formatDateTwig
required: false
readable: true
writeable: false

SupportedProperty
property: dudaUuid
title: dudaUuid
required: false
readable: true
writeable: true

SupportedProperty
property: userIdentifier
title: userIdentifier
required: false
readable: true
writeable: false
description: A visual identifier that represents this user.

SupportedProperty
property: aIType
title: aIType
required: false
readable: true
writeable: true

SupportedProperty
property: aIKey
title: aIKey
required: false
readable: true
writeable: true

SupportedProperty
property: id
title: id
required: false
readable: true
writeable: true

SupportedProperty
property: email
title: email
required: false
readable: true
writeable: true

SupportedProperty
property: businessName
title: businessName
required: false
readable: true
writeable: true

SupportedProperty
property: enabled
title: enabled
required: false
readable: true
writeable: true

SupportedProperty
property: mailOk
title: mailOk
required: false
readable: true
writeable: true

SupportedProperty
property: manyContactEnableForSubAgent
title: manyContactEnableForSubAgent
required: false
readable: true
writeable: true

SupportedProperty
property: campaignsEnableForSubAgent
title: campaignsEnableForSubAgent
required: false
readable: true
writeable: true

SupportedProperty
property: paymentLinksEnableForSubAgent
title: paymentLinksEnableForSubAgent
required: false
readable: true
writeable: true

SupportedProperty
property: transactionsEnableForSubAgent
title: transactionsEnableForSubAgent
required: false
readable: true
writeable: true

SupportedProperty
property: downloadLeadsEnableForSubAgent
title: downloadLeadsEnableForSubAgent
required: false
readable: true
writeable: true

SupportedProperty
property: hideProviders
title: hideProviders
required: false
readable: true
writeable: true

SupportedProperty
property: roles
title: roles
required: false
readable: true
writeable: true

SupportedProperty
property: language
title: language
required: false
readable: true
writeable: true

SupportedProperty
property: managedById
title: managedById
required: false
readable: true
writeable: true

Retrieves a User resource.
type: Operation
type: FindAction
method: GET
title: Retrieves a User resource.
returns: Nothing

Updates the User resource.
type: Operation
expects: User
method: PATCH
title: Updates the User resource.
returns: User

Deletes the User resource.
type: Operation
type: DeleteAction
method: DELETE
title: Deletes the User resource.
returns: Nothing

Deletes the User resource.
type: Operation
type: DeleteAction
method: DELETE
title: Deletes the User resource.
returns: Nothing

Deletes the User resource.
type: Operation
type: DeleteAction
method: DELETE
title: Deletes the User resource.
returns: Nothing