docs.jsonld
type: ApiDocumentation
title: Heyloha API
supported class: Error
supported class: ConstraintViolation
supported class: Availability
supported class: AvailabilityRule
supported class: ExceptionRule
supported class: Appointment
supported class: AppointmentType
supported class: Assistent
supported class: CountRequest
supported class: BulkCountRequest
supported class: StatisticsRequest
supported class: Goal
supported class: SystemGoal
supported class: ChannelRequest
supported class: InstagramAssistent
supported class: LinkedInAssistent
supported class: PhoneAssistent
supported class: WebAssistent
supported class: WhatsAppAssistent
supported class: Chat
supported class: Email
supported class: Interaction
supported class: GreetingAvailabilityRule
supported class: GreetingExceptionRule
supported class: InstructionElement
supported class: TransferNumber
supported class: TransferSettings
supported class: StatisticsForAssistent
supported class: Visitor
supported class: Webhook
supported class: WebhookDelivery
supported class: ToolIntegration
supported class: Brand
supported class: Company
supported class: Team
supported class: User
supported class: Feature
supported class: Logo
supported class: ResourceLimit
supported class: TimeBasedResourceLimit
supported class: Subscription
supported class: CumulativeUsagePerAssistentPerDay
supported class: CumulativeUsagePerPeriod
supported class: CrawlResult
supported class: KillSwitch
supported class: GenerateCustomerPortalLinkResponse
supported class: Account
supported class: Event
supported class: Calendar
supported class: ConstraintViolationList

Error
type: Class
title: Error
supported property: SupportedProperty
  property: Error/id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Error/title
  title: title
  required: false
  readable: true
  writeable: false
  description: A short, human-readable summary of the problem.
supported property: SupportedProperty
  property: Error/detail
  title: detail
  required: false
  readable: true
  writeable: false
  description: A human-readable explanation specific to this occurrence of the problem.
supported property: SupportedProperty
  property: Error/instance
  title: instance
  required: false
  readable: true
  writeable: false
  description: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
supported property: SupportedProperty
  property: Error/type
  title: type
  required: false
  readable: true
  writeable: false
  description: A URI reference that identifies the problem type
supported property: SupportedProperty
  property: Error/meta
  title: meta
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Error/source
  title: source
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Error/description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/trace
  title: trace
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/message
  title: message
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/code
  title: code
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/file
  title: file
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/line
  title: line
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/trace
  title: trace
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Error resource.
  method: GET
  returns: Error
  title: getError
description: A representation of common errors.
sub class of: Error

Error/id
type: Property
domain: Error
the hydra core vocabulary: id
range: string

Error/title
type: Property
domain: Error
the hydra core vocabulary: title
range: string

Error/detail
type: Property
domain: Error
the hydra core vocabulary: detail
range: string

Error/instance
type: Property
domain: Error
the hydra core vocabulary: instance
range: string

Error/type
type: Property
domain: Error
the hydra core vocabulary: type
range: string

Error/meta
type: Property
domain: Error
the hydra core vocabulary: meta

Error/source
type: Property
domain: Error
the hydra core vocabulary: source

Error/description
type: Property
domain: Error
the hydra core vocabulary: description
range: string

Error/trace
type: Property
domain: Error
the hydra core vocabulary: trace

Error/message
type: Property
domain: Error
the hydra core vocabulary: message
range: string

Error/code
type: Property
domain: Error
the hydra core vocabulary: code
range: integer

Error/file
type: Property
domain: Error
the hydra core vocabulary: file
range: string

Error/line
type: Property
domain: Error
the hydra core vocabulary: line
range: integer

ConstraintViolation
type: Class
title: ConstraintViolation
supported property: SupportedProperty
  property: ConstraintViolation/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/errorTitle
  title: errorTitle
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/violations
  title: violations
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/detail
  title: detail
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/message
  title: message
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/code
  title: code
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/file
  title: file
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/line
  title: line
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/type
  title: type
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/title
  title: title
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/instance
  title: instance
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/statusCode
  title: statusCode
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/headers
  title: headers
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/trace
  title: trace
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/previous
  title: previous
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
description: Unprocessable entity
sub class of: Error

ConstraintViolation/status
type: Property
domain: ConstraintViolation
the hydra core vocabulary: status
range: integer

ConstraintViolation/errorTitle
type: Property
domain: ConstraintViolation
the hydra core vocabulary: errorTitle
range: string

ConstraintViolation/violations
type: Property
domain: ConstraintViolation
the hydra core vocabulary: violations
range: ConstraintViolationList

ConstraintViolation/detail
type: Property
domain: ConstraintViolation
the hydra core vocabulary: detail
range: string

ConstraintViolation/message
type: Property
domain: ConstraintViolation
the hydra core vocabulary: message
range: string

ConstraintViolation/code
type: Property
domain: ConstraintViolation
the hydra core vocabulary: code
range: string
range: integer

ConstraintViolation/file
type: Property
domain: ConstraintViolation
the hydra core vocabulary: file
range: string

ConstraintViolation/line
type: Property
domain: ConstraintViolation
the hydra core vocabulary: line
range: integer

ConstraintViolation/description
type: Property
domain: ConstraintViolation
the hydra core vocabulary: description
range: string

ConstraintViolation/type
type: Property
domain: ConstraintViolation
the hydra core vocabulary: type
range: string

ConstraintViolation/title
type: Property
domain: ConstraintViolation
the hydra core vocabulary: title
range: string

ConstraintViolation/instance
type: Property
domain: ConstraintViolation
the hydra core vocabulary: instance
range: string

ConstraintViolation/statusCode
type: Property
domain: ConstraintViolation
the hydra core vocabulary: statusCode
range: integer

ConstraintViolation/headers
type: Property
domain: ConstraintViolation
the hydra core vocabulary: headers

ConstraintViolation/trace
type: Property
domain: ConstraintViolation
the hydra core vocabulary: trace

ConstraintViolation/previous
type: Property
domain: ConstraintViolation
the hydra core vocabulary: previous
range: integer

Availability
type: Class
title: Availability
supported property: SupportedProperty
  property: Availability/exceptionRules
  title: exceptionRules
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Availability/availabilityRules
  title: availabilityRules
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Availability/available
  title: available
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Availability/currentRule
  title: currentRule
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Availability resource.
  method: GET
  returns: Availability
  title: getAvailability

Availability/exceptionRules
type: Property
domain: Availability
the hydra core vocabulary: exceptionRules

Availability/availabilityRules
type: Property
domain: Availability
the hydra core vocabulary: availabilityRules

Availability/available
type: Property
domain: Availability
the hydra core vocabulary: available
range: boolean

Availability/currentRule
type: Property
domain: Availability
the hydra core vocabulary: currentRule
max cardinality: 1
range: AvailabilityRule

AvailabilityRule
type: Class
title: AvailabilityRule
supported property: SupportedProperty
  property: AvailabilityRule/type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: AvailabilityRule/weekDays
  title: weekDays
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: AvailabilityRule/timeFrom
  title: timeFrom
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: AvailabilityRule/timeTo
  title: timeTo
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: AvailabilityRule/origin
  title: origin
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a AvailabilityRule resource.
  method: GET
  returns: AvailabilityRule
  title: getAvailabilityRule
supported operation: Operation
  type: DeleteAction
  description: Deletes the AvailabilityRule resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteAvailabilityRule

AvailabilityRule/type
type: Property
domain: AvailabilityRule
the hydra core vocabulary: type

AvailabilityRule/weekDays
type: Property
domain: AvailabilityRule
the hydra core vocabulary: weekDays

AvailabilityRule/timeFrom
type: Property
domain: AvailabilityRule
the hydra core vocabulary: timeFrom

AvailabilityRule/timeTo
type: Property
domain: AvailabilityRule
the hydra core vocabulary: timeTo

AvailabilityRule/origin
type: Property
domain: AvailabilityRule
the hydra core vocabulary: origin
range: string

ExceptionRule
type: Class
title: ExceptionRule
supported property: SupportedProperty
  property: ExceptionRule/dateFrom
  title: dateFrom
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ExceptionRule/dateTo
  title: dateTo
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ExceptionRule/type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ExceptionRule/timeFrom
  title: timeFrom
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ExceptionRule/timeTo
  title: timeTo
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ExceptionRule/origin
  title: origin
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a ExceptionRule resource.
  method: GET
  returns: ExceptionRule
  title: getExceptionRule
supported operation: Operation
  type: DeleteAction
  description: Deletes the ExceptionRule resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteExceptionRule

ExceptionRule/dateFrom
type: Property
domain: ExceptionRule
the hydra core vocabulary: dateFrom
range: dateTime

ExceptionRule/dateTo
type: Property
domain: ExceptionRule
the hydra core vocabulary: dateTo
range: dateTime

ExceptionRule/type
type: Property
domain: ExceptionRule
the hydra core vocabulary: type

ExceptionRule/timeFrom
type: Property
domain: ExceptionRule
the hydra core vocabulary: timeFrom

ExceptionRule/timeTo
type: Property
domain: ExceptionRule
the hydra core vocabulary: timeTo

ExceptionRule/origin
type: Property
domain: ExceptionRule
the hydra core vocabulary: origin
range: string

Appointment
type: Class
title: Appointment
supported property: SupportedProperty
  property: Appointment/appointmentType
  title: appointmentType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Appointment/start
  title: start
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Appointment/end
  title: end
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Appointment/externalId
  title: externalId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Appointment/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Appointment/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Appointment resource.
  method: GET
  returns: Appointment
  title: getAppointment

Appointment/appointmentType
type: Property
domain: Appointment
the hydra core vocabulary: appointmentType
max cardinality: 1
range: AppointmentType

Appointment/start
type: Property
domain: Appointment
the hydra core vocabulary: start
range: dateTime

Appointment/end
type: Property
domain: Appointment
the hydra core vocabulary: end
range: dateTime

Appointment/externalId
type: Property
domain: Appointment
the hydra core vocabulary: externalId
range: string

Appointment/createdAt
type: Property
domain: Appointment
the hydra core vocabulary: createdAt
range: dateTime

Appointment/updatedAt
type: Property
domain: Appointment
the hydra core vocabulary: updatedAt
range: dateTime

AppointmentType
type: Class
title: AppointmentType
supported property: SupportedProperty
  property: AppointmentType/assistent
  title: assistent
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: AppointmentType/name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: AppointmentType/aiUsage
  title: aiUsage
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: AppointmentType/durationInMinutes
  title: durationInMinutes
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: AppointmentType/bufferBefore
  title: bufferBefore
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: AppointmentType/bufferAfter
  title: bufferAfter
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: AppointmentType/teamsMeeting
  title: teamsMeeting
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: AppointmentType/calendars
  title: calendars
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: AppointmentType/contactDataFields
  title: contactDataFields
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: AppointmentType/availability
  title: availability
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: AppointmentType/contactEmailAddresses
  title: contactEmailAddresses
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: AppointmentType/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: AppointmentType/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a AppointmentType resource.
  method: GET
  returns: AppointmentType
  title: getAppointmentType
supported operation: Operation
  type: DeleteAction
  description: Deletes the AppointmentType resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteAppointmentType

AppointmentType/assistent
type: Property
domain: AppointmentType
the hydra core vocabulary: assistent
max cardinality: 1
range: Assistent

AppointmentType/name
type: Property
domain: AppointmentType
the hydra core vocabulary: name
range: string

AppointmentType/aiUsage
type: Property
domain: AppointmentType
the hydra core vocabulary: aiUsage
range: string

AppointmentType/durationInMinutes
type: Property
domain: AppointmentType
the hydra core vocabulary: durationInMinutes
range: integer

AppointmentType/bufferBefore
type: Property
domain: AppointmentType
the hydra core vocabulary: bufferBefore
range: integer

AppointmentType/bufferAfter
type: Property
domain: AppointmentType
the hydra core vocabulary: bufferAfter
range: integer

AppointmentType/teamsMeeting
type: Property
domain: AppointmentType
the hydra core vocabulary: teamsMeeting
range: boolean

AppointmentType/calendars
type: Property
domain: AppointmentType
the hydra core vocabulary: calendars
range: Calendar

AppointmentType/contactDataFields
type: Property
domain: AppointmentType
the hydra core vocabulary: contactDataFields

AppointmentType/availability
type: Property
domain: AppointmentType
the hydra core vocabulary: availability
max cardinality: 1
range: Availability

AppointmentType/contactEmailAddresses
type: Property
domain: AppointmentType
the hydra core vocabulary: contactEmailAddresses
range: string

AppointmentType/createdAt
type: Property
domain: AppointmentType
the hydra core vocabulary: createdAt
range: dateTime

AppointmentType/updatedAt
type: Property
domain: AppointmentType
the hydra core vocabulary: updatedAt
range: dateTime

Assistent
type: Class
title: Assistent
supported property: SupportedProperty
  property: Assistent/brand
  title: brand
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Assistent/type
  title: type
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Assistent/status
  title: status
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Assistent/crawlStatus
  title: crawlStatus
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Assistent/externalId
  title: externalId
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Assistent/vectorStoreId
  title: vectorStoreId
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Assistent/apiMode
  title: apiMode
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Assistent/language
  title: language
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Assistent/name
  title: name
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Assistent/roles
  title: roles
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Assistent/avatarVariant
  title: avatarVariant
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Assistent/avatar
  title: avatar
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Assistent/features
  title: features
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Assistent/behavior
  title: behavior
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Assistent/emailRouting
  title: emailRouting
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Assistent/greetingAvailability
  title: greetingAvailability
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Assistent/active
  title: active
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Assistent/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Assistent/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Assistent/description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Assistent/capabilities
  title: capabilities
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Assistent/instruction
  title: instruction
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: Assistent/instructionSet
  title: instructionSet
  required: false
  readable: false
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Assistent resource.
  method: GET
  returns: Assistent
  title: getAssistent
supported operation: Operation
  type: DeleteAction
  description: Deletes the Assistent resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteAssistent
supported operation: Operation
  type: FindAction
  description: Retrieves a Assistent resource.
  method: GET
  returns: Assistent
  title: getAssistent
supported property: SupportedProperty
  property: Assistent/brand
  title: brand
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Assistent/type
  title: type
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Assistent/status
  title: status
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Assistent/crawlStatus
  title: crawlStatus
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Assistent/externalId
  title: externalId
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Assistent/vectorStoreId
  title: vectorStoreId
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Assistent/apiMode
  title: apiMode
  required: false
  readable: true
  writeable: false

Assistent/brand
type: Property
domain: Assistent
the hydra core vocabulary: brand
max cardinality: 1
range: Brand

Assistent/type
type: Property
domain: Assistent
the hydra core vocabulary: type

Assistent/status
type: Property
domain: Assistent
the hydra core vocabulary: status

Assistent/crawlStatus
type: Property
domain: Assistent
the hydra core vocabulary: crawlStatus

Assistent/externalId
type: Property
domain: Assistent
the hydra core vocabulary: externalId
range: string

Assistent/vectorStoreId
type: Property
domain: Assistent
the hydra core vocabulary: vectorStoreId
range: string

Assistent/apiMode
type: Property
domain: Assistent
the hydra core vocabulary: apiMode

Assistent/language
type: Property
domain: Assistent
the hydra core vocabulary: language
range: string

Assistent/name
type: Property
domain: Assistent
the hydra core vocabulary: name
range: string

Assistent/roles
type: Property
domain: Assistent
the hydra core vocabulary: roles

Assistent/avatarVariant
type: Property
domain: Assistent
the hydra core vocabulary: avatarVariant

Assistent/avatar
type: Property
domain: Assistent
the hydra core vocabulary: avatar

Assistent/features
type: Property
domain: Assistent
the hydra core vocabulary: features

Assistent/behavior
type: Property
domain: Assistent
the hydra core vocabulary: behavior

Assistent/emailRouting
type: Property
domain: Assistent
the hydra core vocabulary: emailRouting

Assistent/greetingAvailability
type: Property
domain: Assistent
the hydra core vocabulary: greetingAvailability
max cardinality: 1
range: Availability

Assistent/active
type: Property
domain: Assistent
the hydra core vocabulary: active
range: boolean

Assistent/createdAt
type: Property
domain: Assistent
the hydra core vocabulary: createdAt
range: dateTime

Assistent/updatedAt
type: Property
domain: Assistent
the hydra core vocabulary: updatedAt
range: dateTime

Assistent/description
type: Property
domain: Assistent
the hydra core vocabulary: description
range: string

Assistent/capabilities
type: Property
domain: Assistent
the hydra core vocabulary: capabilities

Assistent/instruction
type: Property
domain: Assistent
the hydra core vocabulary: instruction

Assistent/instructionSet
type: Property
domain: Assistent
the hydra core vocabulary: instructionSet

CountRequest
type: Class
title: CountRequest
supported operation: Operation
  type: FindAction
  description: Retrieves a CountRequest resource.
  method: GET
  returns: owl:Nothing
  title: getCountRequest

BulkCountRequest
type: Class
title: BulkCountRequest
supported property: SupportedProperty
  property: BulkCountRequest/assistentIds
  title: assistentIds
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a BulkCountRequest resource.
  method: GET
  returns: owl:Nothing
  title: getBulkCountRequest

BulkCountRequest/assistentIds
type: Property
domain: BulkCountRequest
the hydra core vocabulary: assistentIds
range: string

StatisticsRequest
type: Class
title: StatisticsRequest
supported property: SupportedProperty
  property: StatisticsRequest/assistentId
  title: assistentId
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: StatisticsRequest/type
  title: type
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: StatisticsRequest/range
  title: range
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: StatisticsRequest/channel
  title: channel
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a StatisticsRequest resource.
  method: GET
  returns: owl:Nothing
  title: getStatisticsRequest

StatisticsRequest/assistentId
type: Property
domain: StatisticsRequest
the hydra core vocabulary: assistentId
range: string

StatisticsRequest/type
type: Property
domain: StatisticsRequest
the hydra core vocabulary: type

StatisticsRequest/range
type: Property
domain: StatisticsRequest
the hydra core vocabulary: range

StatisticsRequest/channel
type: Property
domain: StatisticsRequest
the hydra core vocabulary: channel
range: string

Goal
type: Class
title: Goal
supported property: SupportedProperty
  property: Goal/name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Goal/description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Goal/recipientEmail
  title: recipientEmail
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Goal/goalDescription
  title: goalDescription
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Goal/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Goal/functionName
  title: functionName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Goal/functionDescription
  title: functionDescription
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Goal/functionPurpose
  title: functionPurpose
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Goal/functionUsage
  title: functionUsage
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Goal/requiredFields
  title: requiredFields
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Goal/optionalFields
  title: optionalFields
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Goal/messageFieldDescription
  title: messageFieldDescription
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Goal/successMessage
  title: successMessage
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Goal/active
  title: active
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Goal/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Goal/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Goal/name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Goal/description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Goal/recipientEmail
  title: recipientEmail
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Goal/goalDescription
  title: goalDescription
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Goal/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Goal/functionName
  title: functionName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Goal/functionDescription
  title: functionDescription
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Goal/functionPurpose
  title: functionPurpose
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Goal/functionUsage
  title: functionUsage
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Goal/requiredFields
  title: requiredFields
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Goal/optionalFields
  title: optionalFields
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Goal/messageFieldDescription
  title: messageFieldDescription
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Goal/successMessage
  title: successMessage
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Goal/active
  title: active
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Goal/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Goal/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Goal/assistent
  title: assistent
  required: false
  readable: true
  writeable: true
supported operation: Operation

Goal/name
type: Property
domain: Goal
the hydra core vocabulary: name
range: string

Goal/description
type: Property
domain: Goal
the hydra core vocabulary: description
range: string

Goal/recipientEmail
type: Property
domain: Goal
the hydra core vocabulary: recipientEmail
range: string

Goal/goalDescription
type: Property
domain: Goal
the hydra core vocabulary: goalDescription
range: string

Goal/status
type: Property
domain: Goal
the hydra core vocabulary: status

Goal/functionName
type: Property
domain: Goal
the hydra core vocabulary: functionName
range: string

Goal/functionDescription
type: Property
domain: Goal
the hydra core vocabulary: functionDescription
range: string

Goal/functionPurpose
type: Property
domain: Goal
the hydra core vocabulary: functionPurpose
range: string

Goal/functionUsage
type: Property
domain: Goal
the hydra core vocabulary: functionUsage
range: string

Goal/requiredFields
type: Property
domain: Goal
the hydra core vocabulary: requiredFields

Goal/optionalFields
type: Property
domain: Goal
the hydra core vocabulary: optionalFields

Goal/messageFieldDescription
type: Property
domain: Goal
the hydra core vocabulary: messageFieldDescription
range: string

Goal/successMessage
type: Property
domain: Goal
the hydra core vocabulary: successMessage
range: string

Goal/active
type: Property
domain: Goal
the hydra core vocabulary: active
range: boolean

Goal/createdAt
type: Property
domain: Goal
the hydra core vocabulary: createdAt
range: dateTime

Goal/updatedAt
type: Property
domain: Goal
the hydra core vocabulary: updatedAt
range: dateTime

Goal/assistent
type: Property
domain: Goal
the hydra core vocabulary: assistent
max cardinality: 1
range: Assistent

SystemGoal
type: Class
title: SystemGoal
supported property: SupportedProperty
  property: SystemGoal/recipientEmail
  title: recipientEmail
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SystemGoal/requiredFields
  title: requiredFields
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SystemGoal/optionalFields
  title: optionalFields
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SystemGoal/active
  title: active
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SystemGoal/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SystemGoal/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SystemGoal/name
  title: name
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: SystemGoal/description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: SystemGoal/goalDescription
  title: goalDescription
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: SystemGoal/status
  title: status
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: SystemGoal/functionName
  title: functionName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: SystemGoal/functionDescription
  title: functionDescription
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: SystemGoal/functionPurpose
  title: functionPurpose
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: SystemGoal/functionUsage
  title: functionUsage
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: SystemGoal/messageFieldDescription
  title: messageFieldDescription
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: SystemGoal/assistent
  title: assistent
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SystemGoal/recipientEmail
  title: recipientEmail
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SystemGoal/requiredFields
  title: requiredFields
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SystemGoal/optionalFields
  title: optionalFields
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SystemGoal/active
  title: active
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SystemGoal/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SystemGoal/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SystemGoal/name
  title: name
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: SystemGoal/description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: SystemGoal/goalDescription
  title: goalDescription
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: SystemGoal/status
  title: status
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: SystemGoal/functionName
  title: functionName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: SystemGoal/functionDescription
  title: functionDescription
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: SystemGoal/functionPurpose
  title: functionPurpose
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: SystemGoal/functionUsage
  title: functionUsage
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: SystemGoal/messageFieldDescription
  title: messageFieldDescription
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a SystemGoal resource.
  method: GET
  returns: SystemGoal
  title: getSystemGoal

SystemGoal/recipientEmail
type: Property
domain: SystemGoal
the hydra core vocabulary: recipientEmail
range: string

SystemGoal/requiredFields
type: Property
domain: SystemGoal
the hydra core vocabulary: requiredFields

SystemGoal/optionalFields
type: Property
domain: SystemGoal
the hydra core vocabulary: optionalFields

SystemGoal/active
type: Property
domain: SystemGoal
the hydra core vocabulary: active
range: boolean

SystemGoal/createdAt
type: Property
domain: SystemGoal
the hydra core vocabulary: createdAt
range: dateTime

SystemGoal/updatedAt
type: Property
domain: SystemGoal
the hydra core vocabulary: updatedAt
range: dateTime

SystemGoal/name
type: Property
domain: SystemGoal
the hydra core vocabulary: name
range: string

SystemGoal/description
type: Property
domain: SystemGoal
the hydra core vocabulary: description
range: string

SystemGoal/goalDescription
type: Property
domain: SystemGoal
the hydra core vocabulary: goalDescription
range: string

SystemGoal/status
type: Property
domain: SystemGoal
the hydra core vocabulary: status

SystemGoal/functionName
type: Property
domain: SystemGoal
the hydra core vocabulary: functionName
range: string

SystemGoal/functionDescription
type: Property
domain: SystemGoal
the hydra core vocabulary: functionDescription
range: string

SystemGoal/functionPurpose
type: Property
domain: SystemGoal
the hydra core vocabulary: functionPurpose
range: string

SystemGoal/functionUsage
type: Property
domain: SystemGoal
the hydra core vocabulary: functionUsage
range: string

SystemGoal/messageFieldDescription
type: Property
domain: SystemGoal
the hydra core vocabulary: messageFieldDescription
range: string

SystemGoal/assistent
type: Property
domain: SystemGoal
the hydra core vocabulary: assistent
max cardinality: 1
range: Assistent

ChannelRequest
type: Class
title: ChannelRequest
supported operation: Operation
  type: FindAction
  description: Retrieves a ChannelRequest resource.
  method: GET
  returns: owl:Nothing
  title: getChannelRequest

InstagramAssistent
type: Class
title: InstagramAssistent
supported property: SupportedProperty
  property: InstagramAssistent/account
  title: account
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: InstagramAssistent/handoverSettings
  title: handoverSettings
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: InstagramAssistent/brand
  title: brand
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: InstagramAssistent/type
  title: type
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: InstagramAssistent/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: InstagramAssistent/crawlStatus
  title: crawlStatus
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: InstagramAssistent/externalId
  title: externalId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: InstagramAssistent/vectorStoreId
  title: vectorStoreId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: InstagramAssistent/apiMode
  title: apiMode
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: InstagramAssistent/language
  title: language
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: InstagramAssistent/name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: InstagramAssistent/roles
  title: roles
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: InstagramAssistent/avatarVariant
  title: avatarVariant
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: InstagramAssistent/avatar
  title: avatar
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: InstagramAssistent/features
  title: features
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: InstagramAssistent/behavior
  title: behavior
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: InstagramAssistent/emailRouting
  title: emailRouting
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: InstagramAssistent/greetingAvailability
  title: greetingAvailability
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: InstagramAssistent/active
  title: active
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: InstagramAssistent/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: InstagramAssistent/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: InstagramAssistent/capabilities
  title: capabilities
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: InstagramAssistent/description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: InstagramAssistent/instruction
  title: instruction
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: InstagramAssistent/instructionSet
  title: instructionSet
  required: false
  readable: false
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a InstagramAssistent resource.
  method: GET
  returns: InstagramAssistent
  title: getInstagramAssistent

InstagramAssistent/account
type: Property
domain: InstagramAssistent
the hydra core vocabulary: account
max cardinality: 1
range: Account

InstagramAssistent/handoverSettings
type: Property
domain: InstagramAssistent
the hydra core vocabulary: handoverSettings

InstagramAssistent/brand
type: Property
domain: InstagramAssistent
the hydra core vocabulary: brand
max cardinality: 1
range: Brand

InstagramAssistent/type
type: Property
domain: InstagramAssistent
the hydra core vocabulary: type

InstagramAssistent/status
type: Property
domain: InstagramAssistent
the hydra core vocabulary: status

InstagramAssistent/crawlStatus
type: Property
domain: InstagramAssistent
the hydra core vocabulary: crawlStatus

InstagramAssistent/externalId
type: Property
domain: InstagramAssistent
the hydra core vocabulary: externalId
range: string

InstagramAssistent/vectorStoreId
type: Property
domain: InstagramAssistent
the hydra core vocabulary: vectorStoreId
range: string

InstagramAssistent/apiMode
type: Property
domain: InstagramAssistent
the hydra core vocabulary: apiMode

InstagramAssistent/language
type: Property
domain: InstagramAssistent
the hydra core vocabulary: language
range: string

InstagramAssistent/name
type: Property
domain: InstagramAssistent
the hydra core vocabulary: name
range: string

InstagramAssistent/roles
type: Property
domain: InstagramAssistent
the hydra core vocabulary: roles

InstagramAssistent/avatarVariant
type: Property
domain: InstagramAssistent
the hydra core vocabulary: avatarVariant

InstagramAssistent/avatar
type: Property
domain: InstagramAssistent
the hydra core vocabulary: avatar

InstagramAssistent/features
type: Property
domain: InstagramAssistent
the hydra core vocabulary: features

InstagramAssistent/behavior
type: Property
domain: InstagramAssistent
the hydra core vocabulary: behavior

InstagramAssistent/emailRouting
type: Property
domain: InstagramAssistent
the hydra core vocabulary: emailRouting

InstagramAssistent/greetingAvailability
type: Property
domain: InstagramAssistent
the hydra core vocabulary: greetingAvailability
max cardinality: 1
range: Availability

InstagramAssistent/active
type: Property
domain: InstagramAssistent
the hydra core vocabulary: active
range: boolean

InstagramAssistent/createdAt
type: Property
domain: InstagramAssistent
the hydra core vocabulary: createdAt
range: dateTime

InstagramAssistent/updatedAt
type: Property
domain: InstagramAssistent
the hydra core vocabulary: updatedAt
range: dateTime

InstagramAssistent/capabilities
type: Property
domain: InstagramAssistent
the hydra core vocabulary: capabilities

InstagramAssistent/description
type: Property
domain: InstagramAssistent
the hydra core vocabulary: description
range: string

InstagramAssistent/instruction
type: Property
domain: InstagramAssistent
the hydra core vocabulary: instruction

InstagramAssistent/instructionSet
type: Property
domain: InstagramAssistent
the hydra core vocabulary: instructionSet

LinkedInAssistent
type: Class
title: LinkedInAssistent
supported property: SupportedProperty
  property: LinkedInAssistent/account
  title: account
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: LinkedInAssistent/handoverSettings
  title: handoverSettings
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: LinkedInAssistent/brand
  title: brand
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: LinkedInAssistent/type
  title: type
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: LinkedInAssistent/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: LinkedInAssistent/crawlStatus
  title: crawlStatus
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: LinkedInAssistent/externalId
  title: externalId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: LinkedInAssistent/vectorStoreId
  title: vectorStoreId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: LinkedInAssistent/apiMode
  title: apiMode
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: LinkedInAssistent/language
  title: language
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: LinkedInAssistent/name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: LinkedInAssistent/roles
  title: roles
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: LinkedInAssistent/avatarVariant
  title: avatarVariant
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: LinkedInAssistent/avatar
  title: avatar
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: LinkedInAssistent/features
  title: features
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: LinkedInAssistent/behavior
  title: behavior
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: LinkedInAssistent/emailRouting
  title: emailRouting
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: LinkedInAssistent/greetingAvailability
  title: greetingAvailability
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: LinkedInAssistent/active
  title: active
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: LinkedInAssistent/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: LinkedInAssistent/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: LinkedInAssistent/capabilities
  title: capabilities
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: LinkedInAssistent/description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: LinkedInAssistent/instruction
  title: instruction
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: LinkedInAssistent/instructionSet
  title: instructionSet
  required: false
  readable: false
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a LinkedInAssistent resource.
  method: GET
  returns: LinkedInAssistent
  title: getLinkedInAssistent

LinkedInAssistent/account
type: Property
domain: LinkedInAssistent
the hydra core vocabulary: account
max cardinality: 1
range: Account

LinkedInAssistent/handoverSettings
type: Property
domain: LinkedInAssistent
the hydra core vocabulary: handoverSettings

LinkedInAssistent/brand
type: Property
domain: LinkedInAssistent
the hydra core vocabulary: brand
max cardinality: 1
range: Brand

LinkedInAssistent/type
type: Property
domain: LinkedInAssistent
the hydra core vocabulary: type

LinkedInAssistent/status
type: Property
domain: LinkedInAssistent
the hydra core vocabulary: status

LinkedInAssistent/crawlStatus
type: Property
domain: LinkedInAssistent
the hydra core vocabulary: crawlStatus

LinkedInAssistent/externalId
type: Property
domain: LinkedInAssistent
the hydra core vocabulary: externalId
range: string

LinkedInAssistent/vectorStoreId
type: Property
domain: LinkedInAssistent
the hydra core vocabulary: vectorStoreId
range: string

LinkedInAssistent/apiMode
type: Property
domain: LinkedInAssistent
the hydra core vocabulary: apiMode

LinkedInAssistent/language
type: Property
domain: LinkedInAssistent
the hydra core vocabulary: language
range: string

LinkedInAssistent/name
type: Property
domain: LinkedInAssistent
the hydra core vocabulary: name
range: string

LinkedInAssistent/roles
type: Property
domain: LinkedInAssistent
the hydra core vocabulary: roles

LinkedInAssistent/avatarVariant
type: Property
domain: LinkedInAssistent
the hydra core vocabulary: avatarVariant

LinkedInAssistent/avatar
type: Property
domain: LinkedInAssistent
the hydra core vocabulary: avatar

LinkedInAssistent/features
type: Property
domain: LinkedInAssistent
the hydra core vocabulary: features

LinkedInAssistent/behavior
type: Property
domain: LinkedInAssistent
the hydra core vocabulary: behavior

LinkedInAssistent/emailRouting
type: Property
domain: LinkedInAssistent
the hydra core vocabulary: emailRouting

LinkedInAssistent/greetingAvailability
type: Property
domain: LinkedInAssistent
the hydra core vocabulary: greetingAvailability
max cardinality: 1
range: Availability

LinkedInAssistent/active
type: Property
domain: LinkedInAssistent
the hydra core vocabulary: active
range: boolean

LinkedInAssistent/createdAt
type: Property
domain: LinkedInAssistent
the hydra core vocabulary: createdAt
range: dateTime

LinkedInAssistent/updatedAt
type: Property
domain: LinkedInAssistent
the hydra core vocabulary: updatedAt
range: dateTime

LinkedInAssistent/capabilities
type: Property
domain: LinkedInAssistent
the hydra core vocabulary: capabilities

LinkedInAssistent/description
type: Property
domain: LinkedInAssistent
the hydra core vocabulary: description
range: string

LinkedInAssistent/instruction
type: Property
domain: LinkedInAssistent
the hydra core vocabulary: instruction

LinkedInAssistent/instructionSet
type: Property
domain: LinkedInAssistent
the hydra core vocabulary: instructionSet

PhoneAssistent
type: Class
title: PhoneAssistent
supported property: SupportedProperty
  property: PhoneAssistent/type
  title: type
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: PhoneAssistent/voice
  title: voice
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PhoneAssistent/number
  title: number
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PhoneAssistent/regulatoryBundleSid
  title: regulatoryBundleSid
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: PhoneAssistent/complianceStatus
  title: complianceStatus
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: PhoneAssistent/complianceRejectionReasons
  title: complianceRejectionReasons
  required: false
  readable: true
  writeable: false
  description: i18n keys for rejection reasons, set from Twilio webhook when rejected
supported property: SupportedProperty
  property: PhoneAssistent/transferNumbers
  title: transferNumbers
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: PhoneAssistent/transferSettings
  title: transferSettings
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: PhoneAssistent/brand
  title: brand
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PhoneAssistent/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PhoneAssistent/crawlStatus
  title: crawlStatus
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PhoneAssistent/externalId
  title: externalId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PhoneAssistent/vectorStoreId
  title: vectorStoreId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PhoneAssistent/apiMode
  title: apiMode
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: PhoneAssistent/language
  title: language
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PhoneAssistent/name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PhoneAssistent/roles
  title: roles
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PhoneAssistent/avatarVariant
  title: avatarVariant
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PhoneAssistent/avatar
  title: avatar
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PhoneAssistent/features
  title: features
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PhoneAssistent/behavior
  title: behavior
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PhoneAssistent/emailRouting
  title: emailRouting
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: PhoneAssistent/greetingAvailability
  title: greetingAvailability
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: PhoneAssistent/active
  title: active
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PhoneAssistent/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PhoneAssistent/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PhoneAssistent/capabilities
  title: capabilities
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: PhoneAssistent/description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: PhoneAssistent/instruction
  title: instruction
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: PhoneAssistent/instructionSet
  title: instructionSet
  required: false
  readable: false
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a PhoneAssistent resource.
  method: GET
  returns: PhoneAssistent
  title: getPhoneAssistent

PhoneAssistent/type
type: Property
domain: PhoneAssistent
the hydra core vocabulary: type

PhoneAssistent/voice
type: Property
domain: PhoneAssistent
the hydra core vocabulary: voice

PhoneAssistent/number
type: Property
domain: PhoneAssistent
the hydra core vocabulary: number
range: string

PhoneAssistent/regulatoryBundleSid
type: Property
domain: PhoneAssistent
the hydra core vocabulary: regulatoryBundleSid
range: string

PhoneAssistent/complianceStatus
type: Property
domain: PhoneAssistent
the hydra core vocabulary: complianceStatus

PhoneAssistent/complianceRejectionReasons
type: Property
domain: PhoneAssistent
the hydra core vocabulary: complianceRejectionReasons
range: string

PhoneAssistent/transferNumbers
type: Property
domain: PhoneAssistent
the hydra core vocabulary: transferNumbers

PhoneAssistent/transferSettings
type: Property
domain: PhoneAssistent
the hydra core vocabulary: transferSettings
max cardinality: 1
range: TransferSettings

PhoneAssistent/brand
type: Property
domain: PhoneAssistent
the hydra core vocabulary: brand
max cardinality: 1
range: Brand

PhoneAssistent/status
type: Property
domain: PhoneAssistent
the hydra core vocabulary: status

PhoneAssistent/crawlStatus
type: Property
domain: PhoneAssistent
the hydra core vocabulary: crawlStatus

PhoneAssistent/externalId
type: Property
domain: PhoneAssistent
the hydra core vocabulary: externalId
range: string

PhoneAssistent/vectorStoreId
type: Property
domain: PhoneAssistent
the hydra core vocabulary: vectorStoreId
range: string

PhoneAssistent/apiMode
type: Property
domain: PhoneAssistent
the hydra core vocabulary: apiMode

PhoneAssistent/language
type: Property
domain: PhoneAssistent
the hydra core vocabulary: language
range: string

PhoneAssistent/name
type: Property
domain: PhoneAssistent
the hydra core vocabulary: name
range: string

PhoneAssistent/roles
type: Property
domain: PhoneAssistent
the hydra core vocabulary: roles

PhoneAssistent/avatarVariant
type: Property
domain: PhoneAssistent
the hydra core vocabulary: avatarVariant

PhoneAssistent/avatar
type: Property
domain: PhoneAssistent
the hydra core vocabulary: avatar

PhoneAssistent/features
type: Property
domain: PhoneAssistent
the hydra core vocabulary: features

PhoneAssistent/behavior
type: Property
domain: PhoneAssistent
the hydra core vocabulary: behavior

PhoneAssistent/emailRouting
type: Property
domain: PhoneAssistent
the hydra core vocabulary: emailRouting

PhoneAssistent/greetingAvailability
type: Property
domain: PhoneAssistent
the hydra core vocabulary: greetingAvailability
max cardinality: 1
range: Availability

PhoneAssistent/active
type: Property
domain: PhoneAssistent
the hydra core vocabulary: active
range: boolean

PhoneAssistent/createdAt
type: Property
domain: PhoneAssistent
the hydra core vocabulary: createdAt
range: dateTime

PhoneAssistent/updatedAt
type: Property
domain: PhoneAssistent
the hydra core vocabulary: updatedAt
range: dateTime

PhoneAssistent/capabilities
type: Property
domain: PhoneAssistent
the hydra core vocabulary: capabilities

PhoneAssistent/description
type: Property
domain: PhoneAssistent
the hydra core vocabulary: description
range: string

PhoneAssistent/instruction
type: Property
domain: PhoneAssistent
the hydra core vocabulary: instruction

PhoneAssistent/instructionSet
type: Property
domain: PhoneAssistent
the hydra core vocabulary: instructionSet

WebAssistent
type: Class
title: WebAssistent
supported property: SupportedProperty
  property: WebAssistent/voice
  title: voice
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WebAssistent/widget
  title: widget
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WebAssistent/handoverSettings
  title: handoverSettings
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WebAssistent/brand
  title: brand
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WebAssistent/type
  title: type
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: WebAssistent/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WebAssistent/crawlStatus
  title: crawlStatus
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WebAssistent/externalId
  title: externalId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WebAssistent/vectorStoreId
  title: vectorStoreId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WebAssistent/apiMode
  title: apiMode
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: WebAssistent/language
  title: language
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WebAssistent/name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WebAssistent/roles
  title: roles
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WebAssistent/avatarVariant
  title: avatarVariant
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WebAssistent/avatar
  title: avatar
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WebAssistent/features
  title: features
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WebAssistent/behavior
  title: behavior
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WebAssistent/emailRouting
  title: emailRouting
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: WebAssistent/greetingAvailability
  title: greetingAvailability
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: WebAssistent/active
  title: active
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WebAssistent/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WebAssistent/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WebAssistent/capabilities
  title: capabilities
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: WebAssistent/description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: WebAssistent/instruction
  title: instruction
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: WebAssistent/instructionSet
  title: instructionSet
  required: false
  readable: false
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a WebAssistent resource.
  method: GET
  returns: WebAssistent
  title: getWebAssistent

WebAssistent/voice
type: Property
domain: WebAssistent
the hydra core vocabulary: voice

WebAssistent/widget
type: Property
domain: WebAssistent
the hydra core vocabulary: widget

WebAssistent/handoverSettings
type: Property
domain: WebAssistent
the hydra core vocabulary: handoverSettings

WebAssistent/brand
type: Property
domain: WebAssistent
the hydra core vocabulary: brand
max cardinality: 1
range: Brand

WebAssistent/type
type: Property
domain: WebAssistent
the hydra core vocabulary: type

WebAssistent/status
type: Property
domain: WebAssistent
the hydra core vocabulary: status

WebAssistent/crawlStatus
type: Property
domain: WebAssistent
the hydra core vocabulary: crawlStatus

WebAssistent/externalId
type: Property
domain: WebAssistent
the hydra core vocabulary: externalId
range: string

WebAssistent/vectorStoreId
type: Property
domain: WebAssistent
the hydra core vocabulary: vectorStoreId
range: string

WebAssistent/apiMode
type: Property
domain: WebAssistent
the hydra core vocabulary: apiMode

WebAssistent/language
type: Property
domain: WebAssistent
the hydra core vocabulary: language
range: string

WebAssistent/name
type: Property
domain: WebAssistent
the hydra core vocabulary: name
range: string

WebAssistent/roles
type: Property
domain: WebAssistent
the hydra core vocabulary: roles

WebAssistent/avatarVariant
type: Property
domain: WebAssistent
the hydra core vocabulary: avatarVariant

WebAssistent/avatar
type: Property
domain: WebAssistent
the hydra core vocabulary: avatar

WebAssistent/features
type: Property
domain: WebAssistent
the hydra core vocabulary: features

WebAssistent/behavior
type: Property
domain: WebAssistent
the hydra core vocabulary: behavior

WebAssistent/emailRouting
type: Property
domain: WebAssistent
the hydra core vocabulary: emailRouting

WebAssistent/greetingAvailability
type: Property
domain: WebAssistent
the hydra core vocabulary: greetingAvailability
max cardinality: 1
range: Availability

WebAssistent/active
type: Property
domain: WebAssistent
the hydra core vocabulary: active
range: boolean

WebAssistent/createdAt
type: Property
domain: WebAssistent
the hydra core vocabulary: createdAt
range: dateTime

WebAssistent/updatedAt
type: Property
domain: WebAssistent
the hydra core vocabulary: updatedAt
range: dateTime

WebAssistent/capabilities
type: Property
domain: WebAssistent
the hydra core vocabulary: capabilities

WebAssistent/description
type: Property
domain: WebAssistent
the hydra core vocabulary: description
range: string

WebAssistent/instruction
type: Property
domain: WebAssistent
the hydra core vocabulary: instruction

WebAssistent/instructionSet
type: Property
domain: WebAssistent
the hydra core vocabulary: instructionSet

WhatsAppAssistent
type: Class
title: WhatsAppAssistent
supported property: SupportedProperty
  property: WhatsAppAssistent/account
  title: account
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WhatsAppAssistent/handoverSettings
  title: handoverSettings
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WhatsAppAssistent/brand
  title: brand
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WhatsAppAssistent/type
  title: type
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: WhatsAppAssistent/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WhatsAppAssistent/crawlStatus
  title: crawlStatus
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WhatsAppAssistent/externalId
  title: externalId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WhatsAppAssistent/vectorStoreId
  title: vectorStoreId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WhatsAppAssistent/apiMode
  title: apiMode
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: WhatsAppAssistent/language
  title: language
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WhatsAppAssistent/name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WhatsAppAssistent/roles
  title: roles
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WhatsAppAssistent/avatarVariant
  title: avatarVariant
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WhatsAppAssistent/avatar
  title: avatar
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WhatsAppAssistent/features
  title: features
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WhatsAppAssistent/behavior
  title: behavior
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WhatsAppAssistent/emailRouting
  title: emailRouting
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: WhatsAppAssistent/greetingAvailability
  title: greetingAvailability
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: WhatsAppAssistent/active
  title: active
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WhatsAppAssistent/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WhatsAppAssistent/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WhatsAppAssistent/capabilities
  title: capabilities
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: WhatsAppAssistent/description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: WhatsAppAssistent/instruction
  title: instruction
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: WhatsAppAssistent/instructionSet
  title: instructionSet
  required: false
  readable: false
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a WhatsAppAssistent resource.
  method: GET
  returns: WhatsAppAssistent
  title: getWhatsAppAssistent

WhatsAppAssistent/account
type: Property
domain: WhatsAppAssistent
the hydra core vocabulary: account
max cardinality: 1
range: Account

WhatsAppAssistent/handoverSettings
type: Property
domain: WhatsAppAssistent
the hydra core vocabulary: handoverSettings

WhatsAppAssistent/brand
type: Property
domain: WhatsAppAssistent
the hydra core vocabulary: brand
max cardinality: 1
range: Brand

WhatsAppAssistent/type
type: Property
domain: WhatsAppAssistent
the hydra core vocabulary: type

WhatsAppAssistent/status
type: Property
domain: WhatsAppAssistent
the hydra core vocabulary: status

WhatsAppAssistent/crawlStatus
type: Property
domain: WhatsAppAssistent
the hydra core vocabulary: crawlStatus

WhatsAppAssistent/externalId
type: Property
domain: WhatsAppAssistent
the hydra core vocabulary: externalId
range: string

WhatsAppAssistent/vectorStoreId
type: Property
domain: WhatsAppAssistent
the hydra core vocabulary: vectorStoreId
range: string

WhatsAppAssistent/apiMode
type: Property
domain: WhatsAppAssistent
the hydra core vocabulary: apiMode

WhatsAppAssistent/language
type: Property
domain: WhatsAppAssistent
the hydra core vocabulary: language
range: string

WhatsAppAssistent/name
type: Property
domain: WhatsAppAssistent
the hydra core vocabulary: name
range: string

WhatsAppAssistent/roles
type: Property
domain: WhatsAppAssistent
the hydra core vocabulary: roles

WhatsAppAssistent/avatarVariant
type: Property
domain: WhatsAppAssistent
the hydra core vocabulary: avatarVariant

WhatsAppAssistent/avatar
type: Property
domain: WhatsAppAssistent
the hydra core vocabulary: avatar

WhatsAppAssistent/features
type: Property
domain: WhatsAppAssistent
the hydra core vocabulary: features

WhatsAppAssistent/behavior
type: Property
domain: WhatsAppAssistent
the hydra core vocabulary: behavior

WhatsAppAssistent/emailRouting
type: Property
domain: WhatsAppAssistent
the hydra core vocabulary: emailRouting

WhatsAppAssistent/greetingAvailability
type: Property
domain: WhatsAppAssistent
the hydra core vocabulary: greetingAvailability
max cardinality: 1
range: Availability

WhatsAppAssistent/active
type: Property
domain: WhatsAppAssistent
the hydra core vocabulary: active
range: boolean

WhatsAppAssistent/createdAt
type: Property
domain: WhatsAppAssistent
the hydra core vocabulary: createdAt
range: dateTime

WhatsAppAssistent/updatedAt
type: Property
domain: WhatsAppAssistent
the hydra core vocabulary: updatedAt
range: dateTime

WhatsAppAssistent/capabilities
type: Property
domain: WhatsAppAssistent
the hydra core vocabulary: capabilities

WhatsAppAssistent/description
type: Property
domain: WhatsAppAssistent
the hydra core vocabulary: description
range: string

WhatsAppAssistent/instruction
type: Property
domain: WhatsAppAssistent
the hydra core vocabulary: instruction

WhatsAppAssistent/instructionSet
type: Property
domain: WhatsAppAssistent
the hydra core vocabulary: instructionSet

Chat
type: Class
title: Chat
supported property: SupportedProperty
  property: Chat/externalId
  title: externalId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Chat/unipileChatId
  title: unipileChatId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Chat/note
  title: note
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Chat/handoverRequestedAt
  title: handoverRequestedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Chat/handoverExpiresAt
  title: handoverExpiresAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Chat/handoverAcceptedBy
  title: handoverAcceptedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Chat/handoverReferredTo
  title: handoverReferredTo
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Chat/handoverReferredBy
  title: handoverReferredBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Chat/interactions
  title: interactions
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Chat/emails
  title: emails
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Chat/contactData
  title: contactData
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Chat/tags
  title: tags
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Chat/startUrl
  title: startUrl
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Chat/userMessagesCount
  title: userMessagesCount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Chat/duration
  title: duration
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Chat/averageUserResponseTime
  title: averageUserResponseTime
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Chat/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Chat/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Chat/closedAt
  title: closedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Chat/topic
  title: topic
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Chat/closed
  title: closed
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Chat resource.
  method: GET
  returns: Chat
  title: getChat
supported operation: Operation
  type: FindAction
  description: Retrieves a Chat resource.
  method: GET
  returns: Chat
  title: getChat

Chat/externalId
type: Property
domain: Chat
the hydra core vocabulary: externalId
range: string

Chat/unipileChatId
type: Property
domain: Chat
the hydra core vocabulary: unipileChatId
range: string

Chat/note
type: Property
domain: Chat
the hydra core vocabulary: note
range: string

Chat/handoverRequestedAt
type: Property
domain: Chat
the hydra core vocabulary: handoverRequestedAt
range: dateTime

Chat/handoverExpiresAt
type: Property
domain: Chat
the hydra core vocabulary: handoverExpiresAt
range: dateTime

Chat/handoverAcceptedBy
type: Property
domain: Chat
the hydra core vocabulary: handoverAcceptedBy
max cardinality: 1
range: User

Chat/handoverReferredTo
type: Property
domain: Chat
the hydra core vocabulary: handoverReferredTo
max cardinality: 1
range: User

Chat/handoverReferredBy
type: Property
domain: Chat
the hydra core vocabulary: handoverReferredBy
max cardinality: 1
range: User

Chat/interactions
type: Property
domain: Chat
the hydra core vocabulary: interactions

Chat/emails
type: Property
domain: Chat
the hydra core vocabulary: emails

Chat/contactData
type: Property
domain: Chat
the hydra core vocabulary: contactData

Chat/tags
type: Property
domain: Chat
the hydra core vocabulary: tags

Chat/startUrl
type: Property
domain: Chat
the hydra core vocabulary: startUrl
range: string

Chat/userMessagesCount
type: Property
domain: Chat
the hydra core vocabulary: userMessagesCount
range: integer

Chat/duration
type: Property
domain: Chat
the hydra core vocabulary: duration
range: integer

Chat/averageUserResponseTime
type: Property
domain: Chat
the hydra core vocabulary: averageUserResponseTime
range: decimal

Chat/createdAt
type: Property
domain: Chat
the hydra core vocabulary: createdAt
range: dateTime

Chat/updatedAt
type: Property
domain: Chat
the hydra core vocabulary: updatedAt
range: dateTime

Chat/closedAt
type: Property
domain: Chat
the hydra core vocabulary: closedAt
range: dateTime

Chat/topic
type: Property
domain: Chat
the hydra core vocabulary: topic
range: string

Chat/closed
type: Property
domain: Chat
the hydra core vocabulary: closed
range: boolean

Email
type: Class
title: Email
supported property: SupportedProperty
  property: Email/chat
  title: chat
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Email/type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Email/sender
  title: sender
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Email/senderName
  title: senderName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Email/subject
  title: subject
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Email/recipient
  title: recipient
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Email/body
  title: body
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Email/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Email resource.
  method: GET
  returns: Email
  title: getEmail

Email/chat
type: Property
domain: Email
the hydra core vocabulary: chat
max cardinality: 1
range: Chat

Email/type
type: Property
domain: Email
the hydra core vocabulary: type

Email/sender
type: Property
domain: Email
the hydra core vocabulary: sender
range: string

Email/senderName
type: Property
domain: Email
the hydra core vocabulary: senderName
range: string

Email/subject
type: Property
domain: Email
the hydra core vocabulary: subject
range: string

Email/recipient
type: Property
domain: Email
the hydra core vocabulary: recipient
range: string

Email/body
type: Property
domain: Email
the hydra core vocabulary: body
range: string

Email/createdAt
type: Property
domain: Email
the hydra core vocabulary: createdAt
range: dateTime

Interaction
type: Class
title: Interaction
supported property: SupportedProperty
  property: Interaction/type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Interaction/origin
  title: origin
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Interaction/sentBy
  title: sentBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Interaction/url
  title: url
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Interaction/pageTitle
  title: pageTitle
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Interaction/content
  title: content
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Interaction/externalId
  title: externalId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Interaction/completed
  title: completed
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Interaction/context
  title: context
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Interaction/functionName
  title: functionName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Interaction/handoverAcceptedBy
  title: handoverAcceptedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Interaction/handoverReferredTo
  title: handoverReferredTo
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Interaction/handoverReferredBy
  title: handoverReferredBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Interaction/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Interaction resource.
  method: GET
  returns: Interaction
  title: getInteraction

Interaction/type
type: Property
domain: Interaction
the hydra core vocabulary: type

Interaction/origin
type: Property
domain: Interaction
the hydra core vocabulary: origin

Interaction/sentBy
type: Property
domain: Interaction
the hydra core vocabulary: sentBy
max cardinality: 1
range: User

Interaction/url
type: Property
domain: Interaction
the hydra core vocabulary: url
range: string

Interaction/pageTitle
type: Property
domain: Interaction
the hydra core vocabulary: pageTitle
range: string

Interaction/content
type: Property
domain: Interaction
the hydra core vocabulary: content
range: string

Interaction/externalId
type: Property
domain: Interaction
the hydra core vocabulary: externalId
range: string

Interaction/completed
type: Property
domain: Interaction
the hydra core vocabulary: completed
range: boolean

Interaction/context
type: Property
domain: Interaction
the hydra core vocabulary: context

Interaction/functionName
type: Property
domain: Interaction
the hydra core vocabulary: functionName
range: string

Interaction/handoverAcceptedBy
type: Property
domain: Interaction
the hydra core vocabulary: handoverAcceptedBy
max cardinality: 1
range: User

Interaction/handoverReferredTo
type: Property
domain: Interaction
the hydra core vocabulary: handoverReferredTo
max cardinality: 1
range: User

Interaction/handoverReferredBy
type: Property
domain: Interaction
the hydra core vocabulary: handoverReferredBy
max cardinality: 1
range: User

Interaction/createdAt
type: Property
domain: Interaction
the hydra core vocabulary: createdAt
range: dateTime

GreetingAvailabilityRule
type: Class
title: GreetingAvailabilityRule
supported property: SupportedProperty
  property: GreetingAvailabilityRule/greeting
  title: greeting
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: GreetingAvailabilityRule/type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: GreetingAvailabilityRule/weekDays
  title: weekDays
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: GreetingAvailabilityRule/timeFrom
  title: timeFrom
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: GreetingAvailabilityRule/timeTo
  title: timeTo
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: GreetingAvailabilityRule/origin
  title: origin
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a GreetingAvailabilityRule resource.
  method: GET
  returns: GreetingAvailabilityRule
  title: getGreetingAvailabilityRule

GreetingAvailabilityRule/greeting
type: Property
domain: GreetingAvailabilityRule
the hydra core vocabulary: greeting
range: string

GreetingAvailabilityRule/type
type: Property
domain: GreetingAvailabilityRule
the hydra core vocabulary: type

GreetingAvailabilityRule/weekDays
type: Property
domain: GreetingAvailabilityRule
the hydra core vocabulary: weekDays

GreetingAvailabilityRule/timeFrom
type: Property
domain: GreetingAvailabilityRule
the hydra core vocabulary: timeFrom

GreetingAvailabilityRule/timeTo
type: Property
domain: GreetingAvailabilityRule
the hydra core vocabulary: timeTo

GreetingAvailabilityRule/origin
type: Property
domain: GreetingAvailabilityRule
the hydra core vocabulary: origin
range: string

GreetingExceptionRule
type: Class
title: GreetingExceptionRule
supported property: SupportedProperty
  property: GreetingExceptionRule/greeting
  title: greeting
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: GreetingExceptionRule/dateFrom
  title: dateFrom
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: GreetingExceptionRule/dateTo
  title: dateTo
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: GreetingExceptionRule/type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: GreetingExceptionRule/timeFrom
  title: timeFrom
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: GreetingExceptionRule/timeTo
  title: timeTo
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: GreetingExceptionRule/origin
  title: origin
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a GreetingExceptionRule resource.
  method: GET
  returns: GreetingExceptionRule
  title: getGreetingExceptionRule

GreetingExceptionRule/greeting
type: Property
domain: GreetingExceptionRule
the hydra core vocabulary: greeting
range: string

GreetingExceptionRule/dateFrom
type: Property
domain: GreetingExceptionRule
the hydra core vocabulary: dateFrom
range: dateTime

GreetingExceptionRule/dateTo
type: Property
domain: GreetingExceptionRule
the hydra core vocabulary: dateTo
range: dateTime

GreetingExceptionRule/type
type: Property
domain: GreetingExceptionRule
the hydra core vocabulary: type

GreetingExceptionRule/timeFrom
type: Property
domain: GreetingExceptionRule
the hydra core vocabulary: timeFrom

GreetingExceptionRule/timeTo
type: Property
domain: GreetingExceptionRule
the hydra core vocabulary: timeTo

GreetingExceptionRule/origin
type: Property
domain: GreetingExceptionRule
the hydra core vocabulary: origin
range: string

InstructionElement
type: Class
title: InstructionElement
supported property: SupportedProperty
  property: InstructionElement/categorySlug
  title: categorySlug
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: InstructionElement/elementSlug
  title: elementSlug
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: InstructionElement/active
  title: active
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: InstructionElement/instruction
  title: instruction
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: InstructionElement/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: InstructionElement/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a InstructionElement resource.
  method: GET
  returns: InstructionElement
  title: getInstructionElement
supported operation: Operation
  type: DeleteAction
  description: Deletes the InstructionElement resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteInstructionElement

InstructionElement/categorySlug
type: Property
domain: InstructionElement
the hydra core vocabulary: categorySlug
range: string

InstructionElement/elementSlug
type: Property
domain: InstructionElement
the hydra core vocabulary: elementSlug
range: string

InstructionElement/active
type: Property
domain: InstructionElement
the hydra core vocabulary: active
range: boolean

InstructionElement/instruction
type: Property
domain: InstructionElement
the hydra core vocabulary: instruction
range: string

InstructionElement/createdAt
type: Property
domain: InstructionElement
the hydra core vocabulary: createdAt
range: dateTime

InstructionElement/updatedAt
type: Property
domain: InstructionElement
the hydra core vocabulary: updatedAt
range: dateTime

TransferNumber
type: Class
title: TransferNumber
supported property: SupportedProperty
  property: TransferNumber/availability
  title: availability
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: TransferNumber/name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: TransferNumber/phoneNumber
  title: phoneNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: TransferNumber/usageRule
  title: usageRule
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: TransferNumber/transferType
  title: transferType
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a TransferNumber resource.
  method: GET
  returns: TransferNumber
  title: getTransferNumber
supported operation: Operation
  type: DeleteAction
  description: Deletes the TransferNumber resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteTransferNumber

TransferNumber/availability
type: Property
domain: TransferNumber
the hydra core vocabulary: availability
max cardinality: 1
range: Availability

TransferNumber/name
type: Property
domain: TransferNumber
the hydra core vocabulary: name
range: string

TransferNumber/phoneNumber
type: Property
domain: TransferNumber
the hydra core vocabulary: phoneNumber
range: string

TransferNumber/usageRule
type: Property
domain: TransferNumber
the hydra core vocabulary: usageRule
range: string

TransferNumber/transferType
type: Property
domain: TransferNumber
the hydra core vocabulary: transferType

TransferSettings
type: Class
title: TransferSettings
supported property: SupportedProperty
  property: TransferSettings/fallbackMessage
  title: fallbackMessage
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: TransferSettings/fallbackFollowUpMessage
  title: fallbackFollowUpMessage
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: TransferSettings/fallbackTimeout
  title: fallbackTimeout
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: TransferSettings/fallbackRequestCallback
  title: fallbackRequestCallback
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: TransferSettings/fallbackRequestEmailAddress
  title: fallbackRequestEmailAddress
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: TransferSettings/fallbackFields
  title: fallbackFields
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a TransferSettings resource.
  method: GET
  returns: TransferSettings
  title: getTransferSettings

TransferSettings/fallbackMessage
type: Property
domain: TransferSettings
the hydra core vocabulary: fallbackMessage
range: string

TransferSettings/fallbackFollowUpMessage
type: Property
domain: TransferSettings
the hydra core vocabulary: fallbackFollowUpMessage
range: string

TransferSettings/fallbackTimeout
type: Property
domain: TransferSettings
the hydra core vocabulary: fallbackTimeout
range: integer

TransferSettings/fallbackRequestCallback
type: Property
domain: TransferSettings
the hydra core vocabulary: fallbackRequestCallback
range: boolean

TransferSettings/fallbackRequestEmailAddress
type: Property
domain: TransferSettings
the hydra core vocabulary: fallbackRequestEmailAddress
range: string

TransferSettings/fallbackFields
type: Property
domain: TransferSettings
the hydra core vocabulary: fallbackFields

StatisticsForAssistent
type: Class
title: StatisticsForAssistent
supported property: SupportedProperty
  property: StatisticsForAssistent/current
  title: current
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: StatisticsForAssistent/dataScale
  title: dataScale
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: StatisticsForAssistent/data
  title: data
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: StatisticsForAssistent/previous
  title: previous
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a StatisticsForAssistent resource.
  method: GET
  returns: StatisticsForAssistent
  title: getStatisticsForAssistent

StatisticsForAssistent/current
type: Property
domain: StatisticsForAssistent
the hydra core vocabulary: current

StatisticsForAssistent/dataScale
type: Property
domain: StatisticsForAssistent
the hydra core vocabulary: dataScale

StatisticsForAssistent/data
type: Property
domain: StatisticsForAssistent
the hydra core vocabulary: data

StatisticsForAssistent/previous
type: Property
domain: StatisticsForAssistent
the hydra core vocabulary: previous

Visitor
type: Class
title: Visitor
supported property: SupportedProperty
  property: Visitor/currentUrl
  title: currentUrl
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Visitor/deviceType
  title: deviceType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Visitor/language
  title: language
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Visitor/referrer
  title: referrer
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Visitor/screenResolution
  title: screenResolution
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Visitor/source
  title: source
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Visitor/timeZone
  title: timeZone
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Visitor/userAgent
  title: userAgent
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Visitor/browser
  title: browser
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Visitor/utmCampaign
  title: utmCampaign
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Visitor/utmContent
  title: utmContent
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Visitor/utmMedium
  title: utmMedium
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Visitor/utmSource
  title: utmSource
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Visitor/utmTerm
  title: utmTerm
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Visitor/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Visitor resource.
  method: GET
  returns: Visitor
  title: getVisitor

Visitor/currentUrl
type: Property
domain: Visitor
the hydra core vocabulary: currentUrl
range: string

Visitor/deviceType
type: Property
domain: Visitor
the hydra core vocabulary: deviceType
range: string

Visitor/language
type: Property
domain: Visitor
the hydra core vocabulary: language
range: string

Visitor/referrer
type: Property
domain: Visitor
the hydra core vocabulary: referrer
range: string

Visitor/screenResolution
type: Property
domain: Visitor
the hydra core vocabulary: screenResolution
range: string

Visitor/source
type: Property
domain: Visitor
the hydra core vocabulary: source
range: string

Visitor/timeZone
type: Property
domain: Visitor
the hydra core vocabulary: timeZone
range: string

Visitor/userAgent
type: Property
domain: Visitor
the hydra core vocabulary: userAgent
range: string

Visitor/browser
type: Property
domain: Visitor
the hydra core vocabulary: browser
range: string

Visitor/utmCampaign
type: Property
domain: Visitor
the hydra core vocabulary: utmCampaign
range: string

Visitor/utmContent
type: Property
domain: Visitor
the hydra core vocabulary: utmContent
range: string

Visitor/utmMedium
type: Property
domain: Visitor
the hydra core vocabulary: utmMedium
range: string

Visitor/utmSource
type: Property
domain: Visitor
the hydra core vocabulary: utmSource
range: string

Visitor/utmTerm
type: Property
domain: Visitor
the hydra core vocabulary: utmTerm
range: string

Visitor/createdAt
type: Property
domain: Visitor
the hydra core vocabulary: createdAt
range: dateTime

Webhook
type: Class
title: Webhook
supported property: SupportedProperty
  property: Webhook/assistent
  title: assistent
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Webhook/name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Webhook/webhookUrl
  title: webhookUrl
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Webhook/companyParam
  title: companyParam
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Webhook/webhookParam
  title: webhookParam
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Webhook/contactDataFields
  title: contactDataFields
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Webhook/functionName
  title: functionName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Webhook/functionDescription
  title: functionDescription
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Webhook/active
  title: active
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Webhook/type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Webhook/subscribedEvents
  title: subscribedEvents
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Webhook/includeTranscript
  title: includeTranscript
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: Webhook/customProperties
  title: customProperties
  required: false
  readable: true
  writeable: true
  description: Static key-value properties merged into the CRM payload.
supported property: SupportedProperty
  property: Webhook/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Webhook/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Webhook/credentialsConfigured
  title: credentialsConfigured
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Webhook resource.
  method: GET
  returns: Webhook
  title: getWebhook
supported operation: Operation
  type: DeleteAction
  description: Deletes the Webhook resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteWebhook

Webhook/assistent
type: Property
domain: Webhook
the hydra core vocabulary: assistent
max cardinality: 1
range: Assistent

Webhook/name
type: Property
domain: Webhook
the hydra core vocabulary: name
range: string

Webhook/webhookUrl
type: Property
domain: Webhook
the hydra core vocabulary: webhookUrl
range: string

Webhook/companyParam
type: Property
domain: Webhook
the hydra core vocabulary: companyParam
range: string

Webhook/webhookParam
type: Property
domain: Webhook
the hydra core vocabulary: webhookParam
range: string

Webhook/contactDataFields
type: Property
domain: Webhook
the hydra core vocabulary: contactDataFields

Webhook/functionName
type: Property
domain: Webhook
the hydra core vocabulary: functionName
range: string

Webhook/functionDescription
type: Property
domain: Webhook
the hydra core vocabulary: functionDescription
range: string

Webhook/active
type: Property
domain: Webhook
the hydra core vocabulary: active
range: boolean

Webhook/type
type: Property
domain: Webhook
the hydra core vocabulary: type

Webhook/subscribedEvents
type: Property
domain: Webhook
the hydra core vocabulary: subscribedEvents

Webhook/includeTranscript
type: Property
domain: Webhook
the hydra core vocabulary: includeTranscript
range: boolean

Webhook/customProperties
type: Property
domain: Webhook
the hydra core vocabulary: customProperties
range: string

Webhook/createdAt
type: Property
domain: Webhook
the hydra core vocabulary: createdAt
range: dateTime

Webhook/updatedAt
type: Property
domain: Webhook
the hydra core vocabulary: updatedAt
range: dateTime

Webhook/credentialsConfigured
type: Property
domain: Webhook
the hydra core vocabulary: credentialsConfigured
range: boolean

WebhookDelivery
type: Class
title: WebhookDelivery
supported property: SupportedProperty
  property: WebhookDelivery/event
  title: event
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WebhookDelivery/status
  title: status
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: WebhookDelivery/attemptCount
  title: attemptCount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: WebhookDelivery/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WebhookDelivery/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a WebhookDelivery resource.
  method: GET
  returns: WebhookDelivery
  title: getWebhookDelivery
description: Persists every webhook dispatch attempt for the user-facing delivery log.

WebhookDelivery/event
type: Property
domain: WebhookDelivery
the hydra core vocabulary: event

WebhookDelivery/status
type: Property
domain: WebhookDelivery
the hydra core vocabulary: status

WebhookDelivery/attemptCount
type: Property
domain: WebhookDelivery
the hydra core vocabulary: attemptCount
range: integer

WebhookDelivery/createdAt
type: Property
domain: WebhookDelivery
the hydra core vocabulary: createdAt
range: dateTime

WebhookDelivery/updatedAt
type: Property
domain: WebhookDelivery
the hydra core vocabulary: updatedAt
range: dateTime

ToolIntegration
type: Class
title: ToolIntegration
supported property: SupportedProperty
  property: ToolIntegration/type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ToolIntegration/enabled
  title: enabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ToolIntegration/config
  title: config
  required: false
  readable: true
  writeable: true
  description: Non-sensitive configuration (e.g. Shopify shop domain, API version).
supported property: SupportedProperty
  property: ToolIntegration/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ToolIntegration/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ToolIntegration/credentialsConfigured
  title: credentialsConfigured
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a ToolIntegration resource.
  method: GET
  returns: ToolIntegration
  title: getToolIntegration
supported operation: Operation
  type: DeleteAction
  description: Deletes the ToolIntegration resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteToolIntegration
supported operation: Operation
  type: FindAction
  description: Retrieves a ToolIntegration resource.
  method: GET
  returns: ToolIntegration
  title: getToolIntegration
supported operation: Operation
  type: DeleteAction
  description: Deletes the ToolIntegration resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteToolIntegration
description: A customer-configured external service integration that exposes one or more AI tool functions at chat time. Credentials are stored encrypted-at-rest; only the ToolIntegrationCredentialsResolver may decrypt them.

ToolIntegration/type
type: Property
domain: ToolIntegration
the hydra core vocabulary: type

ToolIntegration/enabled
type: Property
domain: ToolIntegration
the hydra core vocabulary: enabled
range: boolean

ToolIntegration/config
type: Property
domain: ToolIntegration
the hydra core vocabulary: config

ToolIntegration/createdAt
type: Property
domain: ToolIntegration
the hydra core vocabulary: createdAt
range: dateTime

ToolIntegration/updatedAt
type: Property
domain: ToolIntegration
the hydra core vocabulary: updatedAt
range: dateTime

ToolIntegration/credentialsConfigured
type: Property
domain: ToolIntegration
the hydra core vocabulary: credentialsConfigured
range: boolean

Brand
type: Class
title: Brand
supported property: SupportedProperty
  property: Brand/company
  title: company
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Brand/name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Brand/logo
  title: logo
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Brand/primaryColor
  title: primaryColor
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Brand/secondaryColor
  title: secondaryColor
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Brand/textColor
  title: textColor
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Brand/linkColor
  title: linkColor
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Brand/buttonColor
  title: buttonColor
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Brand/buttonTextColor
  title: buttonTextColor
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Brand/headingFontName
  title: headingFontName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Brand/fontName
  title: fontName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Brand/googleTagId
  title: googleTagId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Brand/websiteUrl
  title: websiteUrl
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Brand/additionalUrls
  title: additionalUrls
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Brand/active
  title: active
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Brand/teams
  title: teams
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Brand/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Brand/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Brand resource.
  method: GET
  returns: Brand
  title: getBrand
supported operation: Operation
  description: Updates the Brand resource.
  expects: Brand
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: owl:Nothing
  title: patchBrand
supported operation: Operation
  type: DeleteAction
  description: Deletes the Brand resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteBrand

Brand/company
type: Property
domain: Brand
the hydra core vocabulary: company
max cardinality: 1
range: Company

Brand/name
type: Property
domain: Brand
the hydra core vocabulary: name
range: string

Brand/logo
type: Property
domain: Brand
the hydra core vocabulary: logo
max cardinality: 1
range: Logo

Brand/primaryColor
type: Property
domain: Brand
the hydra core vocabulary: primaryColor
range: string

Brand/secondaryColor
type: Property
domain: Brand
the hydra core vocabulary: secondaryColor
range: string

Brand/textColor
type: Property
domain: Brand
the hydra core vocabulary: textColor
range: string

Brand/linkColor
type: Property
domain: Brand
the hydra core vocabulary: linkColor
range: string

Brand/buttonColor
type: Property
domain: Brand
the hydra core vocabulary: buttonColor
range: string

Brand/buttonTextColor
type: Property
domain: Brand
the hydra core vocabulary: buttonTextColor
range: string

Brand/headingFontName
type: Property
domain: Brand
the hydra core vocabulary: headingFontName
range: string

Brand/fontName
type: Property
domain: Brand
the hydra core vocabulary: fontName
range: string

Brand/googleTagId
type: Property
domain: Brand
the hydra core vocabulary: googleTagId
range: string

Brand/websiteUrl
type: Property
domain: Brand
the hydra core vocabulary: websiteUrl
range: string

Brand/additionalUrls
type: Property
domain: Brand
the hydra core vocabulary: additionalUrls
range: string

Brand/active
type: Property
domain: Brand
the hydra core vocabulary: active
range: boolean

Brand/teams
type: Property
domain: Brand
the hydra core vocabulary: teams

Brand/createdAt
type: Property
domain: Brand
the hydra core vocabulary: createdAt
range: dateTime

Brand/updatedAt
type: Property
domain: Brand
the hydra core vocabulary: updatedAt
range: dateTime

Company
type: Class
title: Company
supported property: SupportedProperty
  property: Company/name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Company/customerName
  title: customerName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Company/type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Company/address
  title: address
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Company/phoneNumber
  title: phoneNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Company/email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Company/website
  title: website
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Company/active
  title: active
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Company/webhookEnabled
  title: webhookEnabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Company/locale
  title: locale
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Company/onboardedAt
  title: onboardedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Company/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Company/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Company/topic
  title: topic
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Company resource.
  method: GET
  returns: Company
  title: getCompany
supported operation: Operation
  description: Updates the Company resource.
  expects: Company
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: owl:Nothing
  title: patchCompany
supported operation: Operation
  description: Updates the Company resource.
  expects: Company
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: owl:Nothing
  title: patchCompany
supported operation: Operation
  description: Updates the Company resource.
  expects: Company
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: owl:Nothing
  title: patchCompany
supported operation: Operation
  type: DeleteAction
  description: Deletes the Company resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteCompany
supported operation: Operation
  description: Updates the Company resource.
  expects: Company
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: Company
  title: patchCompany
supported operation: Operation
  description: Updates the Company resource.
  expects: Company
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: Company
  title: patchCompany
supported operation: Operation
  description: Updates the Company resource.
  expects: Company
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: owl:Nothing
  title: patchCompany

Company/name
type: Property
domain: Company
the hydra core vocabulary: name
range: string

Company/customerName
type: Property
domain: Company
the hydra core vocabulary: customerName
range: string

Company/type
type: Property
domain: Company
the hydra core vocabulary: type

Company/address
type: Property
domain: Company
the hydra core vocabulary: address

Company/phoneNumber
type: Property
domain: Company
the hydra core vocabulary: phoneNumber
range: string

Company/email
type: Property
domain: Company
the hydra core vocabulary: email
range: string

Company/website
type: Property
domain: Company
the hydra core vocabulary: website
range: string

Company/active
type: Property
domain: Company
the hydra core vocabulary: active
range: boolean

Company/webhookEnabled
type: Property
domain: Company
the hydra core vocabulary: webhookEnabled
range: boolean

Company/locale
type: Property
domain: Company
the hydra core vocabulary: locale
range: string

Company/onboardedAt
type: Property
domain: Company
the hydra core vocabulary: onboardedAt
range: dateTime

Company/createdAt
type: Property
domain: Company
the hydra core vocabulary: createdAt
range: dateTime

Company/updatedAt
type: Property
domain: Company
the hydra core vocabulary: updatedAt
range: dateTime

Company/topic
type: Property
domain: Company
the hydra core vocabulary: topic
range: string

Team
type: Class
title: Team
supported property: SupportedProperty
  property: Team/company
  title: company
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Team/type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Team/name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Team/displayName
  title: displayName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Team/address
  title: address
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Team/phoneNumber
  title: phoneNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Team/email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Team/website
  title: website
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Team/brand
  title: brand
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Team/active
  title: active
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Team/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Team/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Team/company
  title: company
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Team/type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Team/name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Team/displayName
  title: displayName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Team/address
  title: address
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Team/phoneNumber
  title: phoneNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Team/email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Team/website
  title: website
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Team/brand
  title: brand
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Team/active
  title: active
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Team/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Team/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Team resource.
  method: GET
  returns: Team
  title: getTeam
supported operation: Operation
  description: Updates the Team resource.
  expects: Team
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: owl:Nothing
  title: patchTeam
supported operation: Operation
  description: Updates the Team resource.
  expects: Team
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: owl:Nothing
  title: patchTeam
supported operation: Operation
  description: Updates the Team resource.
  expects: Team
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: owl:Nothing
  title: patchTeam
supported operation: Operation
  description: Updates the Team resource.
  expects: Team
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: owl:Nothing
  title: patchTeam
supported operation: Operation
  description: Updates the Team resource.
  expects: Team
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: owl:Nothing
  title: patchTeam
supported operation: Operation
  description: Updates the Team resource.
  expects: Team
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: owl:Nothing
  title: patchTeam

Team/company
type: Property
domain: Team
the hydra core vocabulary: company
max cardinality: 1
range: Company

Team/type
type: Property
domain: Team
the hydra core vocabulary: type

Team/name
type: Property
domain: Team
the hydra core vocabulary: name
range: string

Team/displayName
type: Property
domain: Team
the hydra core vocabulary: displayName
range: string

Team/address
type: Property
domain: Team
the hydra core vocabulary: address

Team/phoneNumber
type: Property
domain: Team
the hydra core vocabulary: phoneNumber
range: string

Team/email
type: Property
domain: Team
the hydra core vocabulary: email
range: string

Team/website
type: Property
domain: Team
the hydra core vocabulary: website
range: string

Team/brand
type: Property
domain: Team
the hydra core vocabulary: brand
max cardinality: 1
range: Brand

Team/active
type: Property
domain: Team
the hydra core vocabulary: active
range: boolean

Team/createdAt
type: Property
domain: Team
the hydra core vocabulary: createdAt
range: dateTime

Team/updatedAt
type: Property
domain: Team
the hydra core vocabulary: updatedAt
range: dateTime

User
type: Class
title: User
supported property: SupportedProperty
  property: User/company
  title: company
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/gender
  title: gender
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/role
  title: role
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/superAdmin
  title: superAdmin
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/avatar
  title: avatar
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/phoneNumber
  title: phoneNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/mobilePhoneNumber
  title: mobilePhoneNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/absent
  title: absent
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/active
  title: active
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/teams
  title: teams
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/locale
  title: locale
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/birthDate
  title: birthDate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/company
  title: company
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/gender
  title: gender
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/role
  title: role
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/superAdmin
  title: superAdmin
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/avatar
  title: avatar
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/phoneNumber
  title: phoneNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/mobilePhoneNumber
  title: mobilePhoneNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/absent
  title: absent
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/active
  title: active
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/locale
  title: locale
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/birthDate
  title: birthDate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported operation: Operation

User/company
type: Property
domain: User
the hydra core vocabulary: company
max cardinality: 1
range: Company

User/type
type: Property
domain: User
the hydra core vocabulary: type

User/gender
type: Property
domain: User
the hydra core vocabulary: gender

User/name
type: Property
domain: User
the hydra core vocabulary: name

User/email
type: Property
domain: User
the hydra core vocabulary: email
range: string

User/role
type: Property
domain: User
the hydra core vocabulary: role

User/superAdmin
type: Property
domain: User
the hydra core vocabulary: superAdmin
range: boolean

User/avatar
type: Property
domain: User
the hydra core vocabulary: avatar
range: string

User/phoneNumber
type: Property
domain: User
the hydra core vocabulary: phoneNumber
range: string

User/mobilePhoneNumber
type: Property
domain: User
the hydra core vocabulary: mobilePhoneNumber
range: string

User/absent
type: Property
domain: User
the hydra core vocabulary: absent
range: boolean

User/active
type: Property
domain: User
the hydra core vocabulary: active
range: boolean

User/teams
type: Property
domain: User
the hydra core vocabulary: teams
range: Team

User/locale
type: Property
domain: User
the hydra core vocabulary: locale
range: string

User/birthDate
type: Property
domain: User
the hydra core vocabulary: birthDate
range: dateTime

User/createdAt
type: Property
domain: User
the hydra core vocabulary: createdAt
range: dateTime

User/updatedAt
type: Property
domain: User
the hydra core vocabulary: updatedAt
range: dateTime

Feature
type: Class
title: Feature
supported property: SupportedProperty
  property: Feature/externalId
  title: externalId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Feature/name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Feature/slug
  title: slug
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Feature/active
  title: active
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Feature/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Feature/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Feature/type
  title: type
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Feature/externalId
  title: externalId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Feature/name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Feature/slug
  title: slug
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Feature/active
  title: active
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Feature/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Feature/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Feature/type
  title: type
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Feature resource.
  method: GET
  returns: Feature
  title: getFeature

Feature/externalId
type: Property
domain: Feature
the hydra core vocabulary: externalId
range: string

Feature/name
type: Property
domain: Feature
the hydra core vocabulary: name
range: string

Feature/slug
type: Property
domain: Feature
the hydra core vocabulary: slug
range: string

Feature/active
type: Property
domain: Feature
the hydra core vocabulary: active
range: boolean

Feature/createdAt
type: Property
domain: Feature
the hydra core vocabulary: createdAt
range: dateTime

Feature/updatedAt
type: Property
domain: Feature
the hydra core vocabulary: updatedAt
range: dateTime

Feature/type
type: Property
domain: Feature
the hydra core vocabulary: type
range: string

Logo
type: Class
title: Logo
supported property: SupportedProperty
  property: Logo/fileName
  title: fileName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Logo/fileSize
  title: fileSize
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Logo/fileType
  title: fileType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Logo/url
  title: url
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Logo/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Logo/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Logo resource.
  method: GET
  returns: Logo
  title: getLogo
supported operation: Operation
  type: DeleteAction
  description: Deletes the Logo resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteLogo

Logo/fileName
type: Property
domain: Logo
the hydra core vocabulary: fileName
range: string

Logo/fileSize
type: Property
domain: Logo
the hydra core vocabulary: fileSize
range: integer

Logo/fileType
type: Property
domain: Logo
the hydra core vocabulary: fileType
range: string

Logo/url
type: Property
domain: Logo
the hydra core vocabulary: url
range: string

Logo/createdAt
type: Property
domain: Logo
the hydra core vocabulary: createdAt
range: dateTime

Logo/updatedAt
type: Property
domain: Logo
the hydra core vocabulary: updatedAt
range: dateTime

ResourceLimit
type: Class
title: ResourceLimit
supported property: SupportedProperty
  property: ResourceLimit/resource
  title: resource
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ResourceLimit/quantity
  title: quantity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ResourceLimit/externalId
  title: externalId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ResourceLimit/name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ResourceLimit/slug
  title: slug
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ResourceLimit/active
  title: active
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ResourceLimit/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ResourceLimit/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ResourceLimit/type
  title: type
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a ResourceLimit resource.
  method: GET
  returns: ResourceLimit
  title: getResourceLimit

ResourceLimit/resource
type: Property
domain: ResourceLimit
the hydra core vocabulary: resource

ResourceLimit/quantity
type: Property
domain: ResourceLimit
the hydra core vocabulary: quantity
range: integer

ResourceLimit/externalId
type: Property
domain: ResourceLimit
the hydra core vocabulary: externalId
range: string

ResourceLimit/name
type: Property
domain: ResourceLimit
the hydra core vocabulary: name
range: string

ResourceLimit/slug
type: Property
domain: ResourceLimit
the hydra core vocabulary: slug
range: string

ResourceLimit/active
type: Property
domain: ResourceLimit
the hydra core vocabulary: active
range: boolean

ResourceLimit/createdAt
type: Property
domain: ResourceLimit
the hydra core vocabulary: createdAt
range: dateTime

ResourceLimit/updatedAt
type: Property
domain: ResourceLimit
the hydra core vocabulary: updatedAt
range: dateTime

ResourceLimit/type
type: Property
domain: ResourceLimit
the hydra core vocabulary: type
range: string

TimeBasedResourceLimit
type: Class
title: TimeBasedResourceLimit
supported property: SupportedProperty
  property: TimeBasedResourceLimit/interval
  title: interval
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: TimeBasedResourceLimit/intervalCount
  title: intervalCount
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: TimeBasedResourceLimit/resource
  title: resource
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: TimeBasedResourceLimit/quantity
  title: quantity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: TimeBasedResourceLimit/externalId
  title: externalId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: TimeBasedResourceLimit/name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: TimeBasedResourceLimit/slug
  title: slug
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: TimeBasedResourceLimit/active
  title: active
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: TimeBasedResourceLimit/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: TimeBasedResourceLimit/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: TimeBasedResourceLimit/type
  title: type
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a TimeBasedResourceLimit resource.
  method: GET
  returns: TimeBasedResourceLimit
  title: getTimeBasedResourceLimit

TimeBasedResourceLimit/interval
type: Property
domain: TimeBasedResourceLimit
the hydra core vocabulary: interval

TimeBasedResourceLimit/intervalCount
type: Property
domain: TimeBasedResourceLimit
the hydra core vocabulary: intervalCount
range: integer

TimeBasedResourceLimit/resource
type: Property
domain: TimeBasedResourceLimit
the hydra core vocabulary: resource

TimeBasedResourceLimit/quantity
type: Property
domain: TimeBasedResourceLimit
the hydra core vocabulary: quantity
range: integer

TimeBasedResourceLimit/externalId
type: Property
domain: TimeBasedResourceLimit
the hydra core vocabulary: externalId
range: string

TimeBasedResourceLimit/name
type: Property
domain: TimeBasedResourceLimit
the hydra core vocabulary: name
range: string

TimeBasedResourceLimit/slug
type: Property
domain: TimeBasedResourceLimit
the hydra core vocabulary: slug
range: string

TimeBasedResourceLimit/active
type: Property
domain: TimeBasedResourceLimit
the hydra core vocabulary: active
range: boolean

TimeBasedResourceLimit/createdAt
type: Property
domain: TimeBasedResourceLimit
the hydra core vocabulary: createdAt
range: dateTime

TimeBasedResourceLimit/updatedAt
type: Property
domain: TimeBasedResourceLimit
the hydra core vocabulary: updatedAt
range: dateTime

TimeBasedResourceLimit/type
type: Property
domain: TimeBasedResourceLimit
the hydra core vocabulary: type
range: string

Subscription
type: Class
title: Subscription
supported property: SupportedProperty
  property: Subscription/externalId
  title: externalId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Subscription/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Subscription/startAt
  title: startAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Subscription/endAt
  title: endAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Subscription/trial
  title: trial
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Subscription/canceledAt
  title: canceledAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Subscription/cancelAt
  title: cancelAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Subscription/cancelAtPeriodEnd
  title: cancelAtPeriodEnd
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: Subscription/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Subscription/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Subscription/currentlyOverCreditLimit
  title: currentlyOverCreditLimit
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Subscription/currentlyNearbyCreditLimit
  title: currentlyNearbyCreditLimit
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Subscription resource.
  method: GET
  returns: Subscription
  title: getSubscription

Subscription/externalId
type: Property
domain: Subscription
the hydra core vocabulary: externalId
range: string

Subscription/status
type: Property
domain: Subscription
the hydra core vocabulary: status

Subscription/startAt
type: Property
domain: Subscription
the hydra core vocabulary: startAt
range: dateTime

Subscription/endAt
type: Property
domain: Subscription
the hydra core vocabulary: endAt
range: dateTime

Subscription/trial
type: Property
domain: Subscription
the hydra core vocabulary: trial

Subscription/canceledAt
type: Property
domain: Subscription
the hydra core vocabulary: canceledAt
range: dateTime

Subscription/cancelAt
type: Property
domain: Subscription
the hydra core vocabulary: cancelAt
range: dateTime

Subscription/cancelAtPeriodEnd
type: Property
domain: Subscription
the hydra core vocabulary: cancelAtPeriodEnd
range: boolean

Subscription/createdAt
type: Property
domain: Subscription
the hydra core vocabulary: createdAt
range: dateTime

Subscription/updatedAt
type: Property
domain: Subscription
the hydra core vocabulary: updatedAt
range: dateTime

Subscription/currentlyOverCreditLimit
type: Property
domain: Subscription
the hydra core vocabulary: currentlyOverCreditLimit
range: boolean

Subscription/currentlyNearbyCreditLimit
type: Property
domain: Subscription
the hydra core vocabulary: currentlyNearbyCreditLimit
range: boolean

CumulativeUsagePerAssistentPerDay
type: Class
title: CumulativeUsagePerAssistentPerDay
supported property: SupportedProperty
  property: CumulativeUsagePerAssistentPerDay/day
  title: day
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CumulativeUsagePerAssistentPerDay/resource
  title: resource
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CumulativeUsagePerAssistentPerDay/quantity
  title: quantity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CumulativeUsagePerAssistentPerDay/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CumulativeUsagePerAssistentPerDay/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a CumulativeUsagePerAssistentPerDay resource.
  method: GET
  returns: owl:Nothing
  title: getCumulativeUsagePerAssistentPerDay

CumulativeUsagePerAssistentPerDay/day
type: Property
domain: CumulativeUsagePerAssistentPerDay
the hydra core vocabulary: day
range: dateTime

CumulativeUsagePerAssistentPerDay/resource
type: Property
domain: CumulativeUsagePerAssistentPerDay
the hydra core vocabulary: resource

CumulativeUsagePerAssistentPerDay/quantity
type: Property
domain: CumulativeUsagePerAssistentPerDay
the hydra core vocabulary: quantity
range: integer

CumulativeUsagePerAssistentPerDay/createdAt
type: Property
domain: CumulativeUsagePerAssistentPerDay
the hydra core vocabulary: createdAt
range: dateTime

CumulativeUsagePerAssistentPerDay/updatedAt
type: Property
domain: CumulativeUsagePerAssistentPerDay
the hydra core vocabulary: updatedAt
range: dateTime

CumulativeUsagePerPeriod
type: Class
title: CumulativeUsagePerPeriod
supported property: SupportedProperty
  property: CumulativeUsagePerPeriod/fromDate
  title: fromDate
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: CumulativeUsagePerPeriod/untilDate
  title: untilDate
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: CumulativeUsagePerPeriod/resource
  title: resource
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CumulativeUsagePerPeriod/usedQuantity
  title: usedQuantity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CumulativeUsagePerPeriod/entitledQuantity
  title: entitledQuantity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CumulativeUsagePerPeriod/usedQuantityPercentage
  title: usedQuantityPercentage
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: CumulativeUsagePerPeriod/averageQuantityPerDay
  title: averageQuantityPerDay
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: CumulativeUsagePerPeriod/expectedEntitledQuantityReachedDate
  title: expectedEntitledQuantityReachedDate
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: CumulativeUsagePerPeriod/nearbyLimitAt
  title: nearbyLimitAt
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: CumulativeUsagePerPeriod/overLimitAt
  title: overLimitAt
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: CumulativeUsagePerPeriod/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CumulativeUsagePerPeriod/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a CumulativeUsagePerPeriod resource.
  method: GET
  returns: owl:Nothing
  title: getCumulativeUsagePerPeriod

CumulativeUsagePerPeriod/fromDate
type: Property
domain: CumulativeUsagePerPeriod
the hydra core vocabulary: fromDate
range: dateTime

CumulativeUsagePerPeriod/untilDate
type: Property
domain: CumulativeUsagePerPeriod
the hydra core vocabulary: untilDate
range: dateTime

CumulativeUsagePerPeriod/resource
type: Property
domain: CumulativeUsagePerPeriod
the hydra core vocabulary: resource

CumulativeUsagePerPeriod/usedQuantity
type: Property
domain: CumulativeUsagePerPeriod
the hydra core vocabulary: usedQuantity
range: integer

CumulativeUsagePerPeriod/entitledQuantity
type: Property
domain: CumulativeUsagePerPeriod
the hydra core vocabulary: entitledQuantity
range: integer

CumulativeUsagePerPeriod/usedQuantityPercentage
type: Property
domain: CumulativeUsagePerPeriod
the hydra core vocabulary: usedQuantityPercentage
range: decimal

CumulativeUsagePerPeriod/averageQuantityPerDay
type: Property
domain: CumulativeUsagePerPeriod
the hydra core vocabulary: averageQuantityPerDay
range: decimal

CumulativeUsagePerPeriod/expectedEntitledQuantityReachedDate
type: Property
domain: CumulativeUsagePerPeriod
the hydra core vocabulary: expectedEntitledQuantityReachedDate
range: dateTime

CumulativeUsagePerPeriod/nearbyLimitAt
type: Property
domain: CumulativeUsagePerPeriod
the hydra core vocabulary: nearbyLimitAt
range: dateTime

CumulativeUsagePerPeriod/overLimitAt
type: Property
domain: CumulativeUsagePerPeriod
the hydra core vocabulary: overLimitAt
range: dateTime

CumulativeUsagePerPeriod/createdAt
type: Property
domain: CumulativeUsagePerPeriod
the hydra core vocabulary: createdAt
range: dateTime

CumulativeUsagePerPeriod/updatedAt
type: Property
domain: CumulativeUsagePerPeriod
the hydra core vocabulary: updatedAt
range: dateTime

CrawlResult
type: Class
title: CrawlResult
supported property: SupportedProperty
  property: CrawlResult/brand
  title: brand
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CrawlResult/markdown
  title: markdown
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CrawlResult/websiteUrl
  title: websiteUrl
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CrawlResult/externalId
  title: externalId
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: CrawlResult/crawledAt
  title: crawledAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CrawlResult/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CrawlResult/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a CrawlResult resource.
  method: GET
  returns: CrawlResult
  title: getCrawlResult

CrawlResult/brand
type: Property
domain: CrawlResult
the hydra core vocabulary: brand
max cardinality: 1
range: Brand

CrawlResult/markdown
type: Property
domain: CrawlResult
the hydra core vocabulary: markdown
range: string

CrawlResult/websiteUrl
type: Property
domain: CrawlResult
the hydra core vocabulary: websiteUrl
range: string

CrawlResult/externalId
type: Property
domain: CrawlResult
the hydra core vocabulary: externalId
range: string

CrawlResult/crawledAt
type: Property
domain: CrawlResult
the hydra core vocabulary: crawledAt
range: dateTime

CrawlResult/createdAt
type: Property
domain: CrawlResult
the hydra core vocabulary: createdAt
range: dateTime

CrawlResult/updatedAt
type: Property
domain: CrawlResult
the hydra core vocabulary: updatedAt
range: dateTime

KillSwitch
type: Class
title: KillSwitch
supported property: SupportedProperty
  property: KillSwitch/killedBy
  title: killedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: KillSwitch/reason
  title: reason
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: KillSwitch/killedAt
  title: killedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: KillSwitch/resurrectedAt
  title: resurrectedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: KillSwitch/resurrected
  title: resurrected
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a KillSwitch resource.
  method: GET
  returns: KillSwitch
  title: getKillSwitch
supported operation: Operation
  description: Updates the KillSwitch resource.
  expects: KillSwitch
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: owl:Nothing
  title: patchKillSwitch

KillSwitch/killedBy
type: Property
domain: KillSwitch
the hydra core vocabulary: killedBy
max cardinality: 1
range: User

KillSwitch/reason
type: Property
domain: KillSwitch
the hydra core vocabulary: reason
range: string

KillSwitch/killedAt
type: Property
domain: KillSwitch
the hydra core vocabulary: killedAt
range: dateTime

KillSwitch/resurrectedAt
type: Property
domain: KillSwitch
the hydra core vocabulary: resurrectedAt
range: dateTime

KillSwitch/resurrected
type: Property
domain: KillSwitch
the hydra core vocabulary: resurrected
range: boolean

GenerateCustomerPortalLinkResponse
type: Class
title: GenerateCustomerPortalLinkResponse
supported property: SupportedProperty
  property: GenerateCustomerPortalLinkResponse/url
  title: url
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a GenerateCustomerPortalLinkResponse resource.
  method: GET
  returns: owl:Nothing
  title: getGenerateCustomerPortalLinkResponse

GenerateCustomerPortalLinkResponse/url
type: Property
domain: GenerateCustomerPortalLinkResponse
the hydra core vocabulary: url
range: string

Account
type: Class
title: Account
supported property: SupportedProperty
  property: Account/unipileId
  title: unipileId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Account/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Account/name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Account/type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Account/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Account/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Account/connected
  title: connected
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Account/disconnected
  title: disconnected
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Account/pending
  title: pending
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Account/failed
  title: failed
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Account/deleted
  title: deleted
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Account/account
  title: account
  required: false
  readable: false
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Account resource.
  method: GET
  returns: Account
  title: getAccount
supported operation: Operation
  type: DeleteAction
  description: Deletes the Account resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteAccount

Account/unipileId
type: Property
domain: Account
the hydra core vocabulary: unipileId

Account/status
type: Property
domain: Account
the hydra core vocabulary: status

Account/name
type: Property
domain: Account
the hydra core vocabulary: name
range: string

Account/type
type: Property
domain: Account
the hydra core vocabulary: type

Account/createdAt
type: Property
domain: Account
the hydra core vocabulary: createdAt
range: dateTime

Account/updatedAt
type: Property
domain: Account
the hydra core vocabulary: updatedAt
range: dateTime

Account/connected
type: Property
domain: Account
the hydra core vocabulary: connected
range: boolean

Account/disconnected
type: Property
domain: Account
the hydra core vocabulary: disconnected
range: boolean

Account/pending
type: Property
domain: Account
the hydra core vocabulary: pending
range: boolean

Account/failed
type: Property
domain: Account
the hydra core vocabulary: failed
range: boolean

Account/deleted
type: Property
domain: Account
the hydra core vocabulary: deleted
range: boolean

Account/account
type: Property
domain: Account
the hydra core vocabulary: account

Event
type: Class
title: Event
supported property: SupportedProperty
  property: Event/object
  title: object
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Event/id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Event/master event id
  title: master_event_id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Event/calendar id
  title: calendar_id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Event/created at
  title: created_at
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Event/updated at
  title: updated_at
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Event/title
  title: title
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Event/body
  title: body
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Event/location
  title: location
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Event/is cancelled
  title: is_cancelled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Event/is all day
  title: is_all_day
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Event/is attendees list hidden
  title: is_attendees_list_hidden
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Event/attendees
  title: attendees
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Event/start
  title: start
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Event/end
  title: end
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Event/recurrence
  title: recurrence
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Event/organizer
  title: organizer
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Event/conference
  title: conference
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Event/visibility
  title: visibility
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Event/transparency
  title: transparency
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Event/event type
  title: event_type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Event/accountId
  title: accountId
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Event resource.
  method: GET
  returns: Event
  title: getEvent

Event/object
type: Property
domain: Event
the hydra core vocabulary: object
range: string

Event/id
type: Property
domain: Event
the hydra core vocabulary: id
range: string

Event/master event id
type: Property
domain: Event
the hydra core vocabulary: master_event_id
range: string

Event/calendar id
type: Property
domain: Event
the hydra core vocabulary: calendar_id
range: string

Event/created at
type: Property
domain: Event
the hydra core vocabulary: created_at
range: dateTime

Event/updated at
type: Property
domain: Event
the hydra core vocabulary: updated_at
range: dateTime

Event/title
type: Property
domain: Event
the hydra core vocabulary: title
range: string

Event/body
type: Property
domain: Event
the hydra core vocabulary: body
range: string

Event/location
type: Property
domain: Event
the hydra core vocabulary: location
range: string

Event/is cancelled
type: Property
domain: Event
the hydra core vocabulary: is_cancelled
range: boolean

Event/is all day
type: Property
domain: Event
the hydra core vocabulary: is_all_day
range: boolean

Event/is attendees list hidden
type: Property
domain: Event
the hydra core vocabulary: is_attendees_list_hidden
range: boolean

Event/attendees
type: Property
domain: Event
the hydra core vocabulary: attendees

Event/start
type: Property
domain: Event
the hydra core vocabulary: start
range: dateTime

Event/end
type: Property
domain: Event
the hydra core vocabulary: end
range: dateTime

Event/recurrence
type: Property
domain: Event
the hydra core vocabulary: recurrence
range: string

Event/organizer
type: Property
domain: Event
the hydra core vocabulary: organizer
range: string

Event/conference
type: Property
domain: Event
the hydra core vocabulary: conference
range: string

Event/visibility
type: Property
domain: Event
the hydra core vocabulary: visibility
range: string

Event/transparency
type: Property
domain: Event
the hydra core vocabulary: transparency
range: string

Event/event type
type: Property
domain: Event
the hydra core vocabulary: event_type
range: string

Event/accountId
type: Property
domain: Event
the hydra core vocabulary: accountId
range: string

Calendar
type: Class
title: Calendar
supported property: SupportedProperty
  property: Calendar/account
  title: account
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Calendar/unipileId
  title: unipileId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Calendar/name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Calendar/readOnly
  title: readOnly
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Calendar/defaultCalendar
  title: defaultCalendar
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Calendar/ownedByUser
  title: ownedByUser
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Calendar/backgroundColor
  title: backgroundColor
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Calendar/active
  title: active
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Calendar/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Calendar/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Calendar resource.
  method: GET
  returns: Calendar
  title: getCalendar

Calendar/account
type: Property
domain: Calendar
the hydra core vocabulary: account
max cardinality: 1
range: Account

Calendar/unipileId
type: Property
domain: Calendar
the hydra core vocabulary: unipileId

Calendar/name
type: Property
domain: Calendar
the hydra core vocabulary: name
range: string

Calendar/readOnly
type: Property
domain: Calendar
the hydra core vocabulary: readOnly
range: boolean

Calendar/defaultCalendar
type: Property
domain: Calendar
the hydra core vocabulary: defaultCalendar
range: boolean

Calendar/ownedByUser
type: Property
domain: Calendar
the hydra core vocabulary: ownedByUser
range: boolean

Calendar/backgroundColor
type: Property
domain: Calendar
the hydra core vocabulary: backgroundColor
range: string

Calendar/active
type: Property
domain: Calendar
the hydra core vocabulary: active
range: boolean

Calendar/createdAt
type: Property
domain: Calendar
the hydra core vocabulary: createdAt
range: dateTime

Calendar/updatedAt
type: Property
domain: Calendar
the hydra core vocabulary: updatedAt
range: dateTime

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

ConstraintViolationList/propertyPath
type: Property
label: propertyPath
domain: ConstraintViolationList
range: string

ConstraintViolationList/message
type: Property
label: message
domain: ConstraintViolationList
range: string

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

SupportedProperty
property: Assistent/name
title: name
required: false
readable: true
writeable: false

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

SupportedProperty
property: Assistent/avatarVariant
title: avatarVariant
required: false
readable: true
writeable: false

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

SupportedProperty
property: Assistent/features
title: features
required: false
readable: true
writeable: false

SupportedProperty
property: Assistent/behavior
title: behavior
required: false
readable: true
writeable: false

SupportedProperty
property: Assistent/emailRouting
title: emailRouting
required: false
readable: true
writeable: false

SupportedProperty
property: Assistent/greetingAvailability
title: greetingAvailability
required: false
readable: true
writeable: false

SupportedProperty
property: Assistent/active
title: active
required: false
readable: true
writeable: false

SupportedProperty
property: Assistent/createdAt
title: createdAt
required: false
readable: true
writeable: false

SupportedProperty
property: Assistent/updatedAt
title: updatedAt
required: false
readable: true
writeable: false

SupportedProperty
property: Assistent/description
title: description
required: false
readable: true
writeable: false

SupportedProperty
property: Assistent/capabilities
title: capabilities
required: false
readable: true
writeable: false

SupportedProperty
property: Assistent/instruction
title: instruction
required: false
readable: false
writeable: false

SupportedProperty
property: Assistent/instructionSet
title: instructionSet
required: false
readable: false
writeable: false

Operation
type: FindAction
description: Retrieves a Assistent resource.
method: GET
returns: Assistent
title: getAssistent

Operation
type: FindAction
description: Retrieves a Assistent resource.
method: GET
returns: Assistent
title: getAssistent

Operation
type: FindAction
description: Retrieves a Assistent resource.
method: GET
returns: Assistent
title: getAssistent

SupportedProperty
property: Goal/name
title: name
required: false
readable: true
writeable: true

SupportedProperty
property: Goal/description
title: description
required: false
readable: true
writeable: true

SupportedProperty
property: Goal/recipientEmail
title: recipientEmail
required: false
readable: true
writeable: true

SupportedProperty
property: Goal/goalDescription
title: goalDescription
required: false
readable: true
writeable: true

SupportedProperty
property: Goal/status
title: status
required: false
readable: true
writeable: true

SupportedProperty
property: Goal/functionName
title: functionName
required: false
readable: true
writeable: false

SupportedProperty
property: Goal/functionDescription
title: functionDescription
required: false
readable: true
writeable: false

SupportedProperty
property: Goal/functionPurpose
title: functionPurpose
required: false
readable: true
writeable: false

SupportedProperty
property: Goal/functionUsage
title: functionUsage
required: false
readable: true
writeable: false

SupportedProperty
property: Goal/requiredFields
title: requiredFields
required: false
readable: true
writeable: false

SupportedProperty
property: Goal/optionalFields
title: optionalFields
required: false
readable: true
writeable: false

SupportedProperty
property: Goal/messageFieldDescription
title: messageFieldDescription
required: false
readable: true
writeable: false

SupportedProperty
property: Goal/successMessage
title: successMessage
required: false
readable: true
writeable: false

SupportedProperty
property: Goal/active
title: active
required: false
readable: true
writeable: true

SupportedProperty
property: Goal/createdAt
title: createdAt
required: false
readable: true
writeable: true

SupportedProperty
property: Goal/updatedAt
title: updatedAt
required: false
readable: true
writeable: true

Operation
type: FindAction
description: Retrieves a Goal resource.
method: GET
returns: Goal
title: getGoal

Operation
type: DeleteAction
description: Deletes the Goal resource.
method: DELETE
returns: owl:Nothing
title: deleteGoal

Operation
description: Updates the Team resource.
expects: Team
expects header:
  header name: Content-Type
  possible value: application/merge-patch+json
method: PATCH
returns: owl:Nothing
title: patchTeam

Operation
description: Updates the Team resource.
expects: Team
expects header:
  header name: Content-Type
  possible value: application/merge-patch+json
method: PATCH
returns: owl:Nothing
title: patchTeam

Operation
description: Updates the Team resource.
expects: Team
expects header:
  header name: Content-Type
  possible value: application/merge-patch+json
method: PATCH
returns: owl:Nothing
title: patchTeam

Operation
description: Updates the Team resource.
expects: Team
expects header:
  header name: Content-Type
  possible value: application/merge-patch+json
method: PATCH
returns: owl:Nothing
title: patchTeam

Operation
description: Updates the Team resource.
expects: Team
expects header:
  header name: Content-Type
  possible value: application/merge-patch+json
method: PATCH
returns: owl:Nothing
title: patchTeam

Operation
description: Updates the Team resource.
expects: Team
expects header:
  header name: Content-Type
  possible value: application/merge-patch+json
method: PATCH
returns: owl:Nothing
title: patchTeam

Operation
type: DeleteAction
description: Deletes the Team resource.
method: DELETE
returns: owl:Nothing
title: deleteTeam

SupportedProperty
property: Team/company
title: company
required: false
readable: true
writeable: true

SupportedProperty
property: Team/type
title: type
required: false
readable: true
writeable: true

SupportedProperty
property: Team/name
title: name
required: false
readable: true
writeable: true

SupportedProperty
property: Team/displayName
title: displayName
required: false
readable: true
writeable: true

SupportedProperty
property: Team/address
title: address
required: false
readable: true
writeable: true

SupportedProperty
property: Team/phoneNumber
title: phoneNumber
required: false
readable: true
writeable: true

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

SupportedProperty
property: Team/website
title: website
required: false
readable: true
writeable: true

SupportedProperty
property: Team/brand
title: brand
required: false
readable: true
writeable: true

SupportedProperty
property: Team/active
title: active
required: false
readable: true
writeable: true

SupportedProperty
property: Team/createdAt
title: createdAt
required: false
readable: true
writeable: true

SupportedProperty
property: Team/updatedAt
title: updatedAt
required: false
readable: true
writeable: true

SupportedProperty
property: User/company
title: company
required: false
readable: true
writeable: true

SupportedProperty
property: User/type
title: type
required: false
readable: true
writeable: true

SupportedProperty
property: User/gender
title: gender
required: false
readable: true
writeable: true

SupportedProperty
property: User/name
title: name
required: false
readable: true
writeable: true

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

SupportedProperty
property: User/role
title: role
required: false
readable: true
writeable: true

SupportedProperty
property: User/superAdmin
title: superAdmin
required: false
readable: true
writeable: true

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

SupportedProperty
property: User/phoneNumber
title: phoneNumber
required: false
readable: true
writeable: true

SupportedProperty
property: User/mobilePhoneNumber
title: mobilePhoneNumber
required: false
readable: true
writeable: true

SupportedProperty
property: User/absent
title: absent
required: false
readable: true
writeable: true

SupportedProperty
property: User/active
title: active
required: false
readable: true
writeable: true

SupportedProperty
property: User/teams
title: teams
required: false
readable: true
writeable: true

SupportedProperty
property: User/locale
title: locale
required: false
readable: true
writeable: true

SupportedProperty
property: User/birthDate
title: birthDate
required: false
readable: true
writeable: true

SupportedProperty
property: User/createdAt
title: createdAt
required: false
readable: true
writeable: true

SupportedProperty
property: User/updatedAt
title: updatedAt
required: false
readable: true
writeable: true

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

Operation
description: Updates the User resource.
expects: User
expects header:
  header name: Content-Type
  possible value: application/merge-patch+json
method: PATCH
returns: owl:Nothing
title: patchUser

Operation
description: Updates the User resource.
expects: User
expects header:
  header name: Content-Type
  possible value: application/merge-patch+json
method: PATCH
returns: owl:Nothing
title: patchUser

Operation
description: Updates the User resource.
expects: User
expects header:
  header name: Content-Type
  possible value: application/merge-patch+json
method: PATCH
returns: owl:Nothing
title: patchUser

Operation
description: Updates the User resource.
expects: User
expects header:
  header name: Content-Type
  possible value: application/merge-patch+json
method: PATCH
returns: owl:Nothing
title: patchUser

Operation
description: Updates the User resource.
expects: User
expects header:
  header name: Content-Type
  possible value: application/merge-patch+json
method: PATCH
returns: owl:Nothing
title: patchUser

Operation
description: Updates the User resource.
expects: User
expects header:
  header name: Content-Type
  possible value: application/merge-patch+json
method: PATCH
returns: owl:Nothing
title: patchUser

Operation
description: Updates the User resource.
expects: User
expects header:
  header name: Content-Type
  possible value: application/merge-patch+json
method: PATCH
returns: owl:Nothing
title: patchUser

Operation
description: Updates the User resource.
expects: User
expects header:
  header name: Content-Type
  possible value: application/merge-patch+json
method: PATCH
returns: owl:Nothing
title: patchUser

Operation
description: Updates the User resource.
expects: User
expects header:
  header name: Content-Type
  possible value: application/merge-patch+json
method: PATCH
returns: owl:Nothing
title: patchUser

Operation
description: Updates the User resource.
expects: User
expects header:
  header name: Content-Type
  possible value: application/merge-patch+json
method: PATCH
returns: owl:Nothing
title: patchUser

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