docs.jsonld
type: ApiDocumentation
entrypoint: /api
supported class: User
supported class: VideoRoom
supported class: Company
supported class: UserCompanyProfile
supported class: Conversation
supported class: Message
supported class: UserMessage
supported class: ConversationUser
supported class: VideoRoomRequest
supported class: ChatRequest
supported class: CallReview
supported class: VideoRecording
supported class: ExternalUser
supported class: MessageFile
supported class: MediaObject
supported class: UserMessageReaction
supported class: MissedCall
supported class: DialedCall
supported class: AttendanceExportRequest
supported class: ExternalCustomer
supported class: SignatureRequest
supported class: Entrypoint
supported class: ConstraintViolation
supported class: ConstraintViolationList

User
type: Class
title: User
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: online
  title: online
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: inRoom
  title: inRoom
  required: false
  readable: false
  writeable: true
  description: Whether the user is in a video room right now
supported property: SupportedProperty
  property: inRoomCompanyUuid
  title: inRoomCompanyUuid
  required: false
  readable: true
  writeable: false
  description: The company uuid where user is in call
supported property: SupportedProperty
  property: userHeadshot
  title: userHeadshot
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: headshotTime
  title: headshotTime
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: fullName
  title: fullName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: lastOnlineTime
  title: lastOnlineTime
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: lastEmailReminderTime
  title: lastEmailReminderTime
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: lastSmsReminderTime
  title: lastSmsReminderTime
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: inConversation
  title: inConversation
  required: false
  readable: false
  writeable: true
  description: Whether the user is in a chat right now
supported property: SupportedProperty
  property: inMessage
  title: inMessage
  required: false
  readable: false
  writeable: true
  description: Whether the user is in a thread right now
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: tokenUpdatedAt
  title: tokenUpdatedAt
  required: false
  readable: true
  writeable: true
supported operation: Retrieves User resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves User resource.
  returns: User
supported operation: Updates the User resource.
  type: Operation
  expects: User
  method: PATCH
  title: Updates the User resource.
  returns: User
supported operation: Deletes the User resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the User resource.
  returns: Nothing
supported operation: Updates the User resource.
  type: Operation
  expects: User
  method: PATCH
  title: Updates the User resource.
  returns: User
supported operation: Creates a User resource.
  type: Operation
  type: CreateAction
  expects: User
  method: POST
  title: Creates a User resource.
  returns: User
supported operation: Retrieves the collection of UserCompanyProfile resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of UserCompanyProfile resources.
  returns: UserCompanyProfile

email
type: Property
domain: User
range: string

online
type: Property
domain: User
range: boolean

status
type: Property
domain: User
range: integer

inRoom
type: Property
domain: User
max cardinality: 1
range: VideoRoom

inRoomCompanyUuid
type: Property
domain: User

userHeadshot
type: Property
domain: User
max cardinality: 1
range: MediaObject

headshotTime
type: Property
domain: User
range: dateTime

fullName
type: Property
domain: User
range: string

lastOnlineTime
type: Property
domain: User
range: dateTime

lastEmailReminderTime
type: Property
domain: User
range: dateTime

lastSmsReminderTime
type: Property
domain: User
range: dateTime

inConversation
type: Property
domain: User
max cardinality: 1
range: Conversation

inMessage
type: Property
domain: User
max cardinality: 1
range: Message

type
type: Property
domain: User
range: integer

tokenUpdatedAt
type: Property
domain: User
range: dateTime

VideoRoom
type: Class
title: VideoRoom
supported property: SupportedProperty
  property: name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: creator
  title: creator
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: expireAt
  title: expireAt
  required: false
  readable: true
  writeable: true
  description: Video room will be expired on this date if it is not null. This should be set only for temporary rooms.
supported property: SupportedProperty
  property: private
  title: private
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: company
  title: company
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: recording
  title: recording
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: conversation
  title: conversation
  required: false
  readable: false
  writeable: true
supported operation: Retrieves VideoRoom resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves VideoRoom resource.
  returns: VideoRoom
supported operation: Retrieves VideoRoom resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves VideoRoom resource.
  returns: VideoRoom
supported operation: Updates the VideoRoom resource.
  type: Operation
  expects: VideoRoom
  method: PATCH
  title: Updates the VideoRoom resource.
  returns: VideoRoom
supported operation: Updates the VideoRoom resource.
  type: Operation
  expects: VideoRoom
  method: PATCH
  title: Updates the VideoRoom resource.
  returns: VideoRoom
supported operation: Creates a VideoRoom resource.
  type: Operation
  type: CreateAction
  expects: VideoRoom
  method: POST
  title: Creates a VideoRoom resource.
  returns: VideoRoom
description: VideoRoom

name
type: Property
domain: VideoRoom
range: string

description
type: Property
domain: VideoRoom
range: string

creator
type: Property
domain: VideoRoom
max cardinality: 1
range: User

expireAt
type: Property
domain: VideoRoom
range: dateTime

private
type: Property
domain: VideoRoom
range: boolean

company
type: Property
domain: VideoRoom
max cardinality: 1
range: Company

recording
type: Property
domain: VideoRoom
range: boolean

conversation
type: Property
domain: VideoRoom
max cardinality: 1
range: Conversation

Company
type: Class
title: Company
supported property: SupportedProperty
  property: startTime
  title: startTime
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: endTime
  title: endTime
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: loginReminderEnabled
  title: loginReminderEnabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: absentReminderEnabled
  title: absentReminderEnabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: fullDayHours
  title: fullDayHours
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: halfDayHours
  title: halfDayHours
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: hrEmail
  title: hrEmail
  required: false
  readable: true
  writeable: true
supported operation: Retrieves Company resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Company resource.
  returns: Company
supported operation: Updates the Company resource.
  type: Operation
  expects: Company
  method: PATCH
  title: Updates the Company resource.
  returns: Company
supported operation: Retrieves Company resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Company resource.
  returns: Company
supported operation: Retrieves Company resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Company resource.
  returns: Company
supported operation: Retrieves Company resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Company resource.
  returns: Company
supported operation: Creates a Company resource.
  type: Operation
  type: CreateAction
  expects: Company
  method: POST
  title: Creates a Company resource.
  returns: Company
supported operation: Creates a Company resource.
  type: Operation
  type: CreateAction
  expects: Company
  method: POST
  title: Creates a Company resource.
  returns: Company
supported operation: Retrieves the collection of UserCompanyProfile resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of UserCompanyProfile resources.
  returns: UserCompanyProfile

startTime
type: Property
domain: Company
range: dateTime

endTime
type: Property
domain: Company
range: dateTime

loginReminderEnabled
type: Property
domain: Company
range: boolean

absentReminderEnabled
type: Property
domain: Company
range: boolean

name
type: Property
domain: Company
range: string

fullDayHours
type: Property
domain: Company
range: integer

halfDayHours
type: Property
domain: Company
range: integer

hrEmail
type: Property
domain: Company
range: string

UserCompanyProfile
type: Class
title: UserCompanyProfile
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: bravos
  title: bravos
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: bravosPostId
  title: bravosPostId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: bravosGivenAt
  title: bravosGivenAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: enabled
  title: enabled
  required: false
  readable: true
  writeable: true
supported operation: Retrieves UserCompanyProfile resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves UserCompanyProfile resource.
  returns: UserCompanyProfile
supported operation: Updates the UserCompanyProfile resource.
  type: Operation
  expects: UserCompanyProfile
  method: PATCH
  title: Updates the UserCompanyProfile resource.
  returns: UserCompanyProfile
supported operation: Deletes the UserCompanyProfile resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the UserCompanyProfile resource.
  returns: Nothing

user
type: Property
domain: UserCompanyProfile
max cardinality: 1
range: User

bravos
type: Property
domain: UserCompanyProfile
range: integer

bravosPostId
type: Property
domain: UserCompanyProfile
range: integer

bravosGivenAt
type: Property
domain: UserCompanyProfile
range: dateTime

enabled
type: Property
domain: UserCompanyProfile
range: boolean

Conversation
type: Class
title: Conversation
supported property: SupportedProperty
  property: type
  title: type
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: externalUser
  title: externalUser
  required: false
  readable: true
  writeable: false
  description: External participant
supported property: SupportedProperty
  property: dashboardUuid
  title: dashboardUuid
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: workBotConversationUuid
  title: workBotConversationUuid
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: respondedAt
  title: respondedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: topic
  title: topic
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: requestedAt
  title: requestedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: closedAt
  title: closedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: language
  title: language
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: created
  title: created
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updated
  title: updated
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: closed
  title: closed
  required: false
  readable: false
  writeable: true
supported operation: Retrieves Conversation resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Conversation resource.
  returns: Conversation
supported operation: Updates the Conversation resource.
  type: Operation
  expects: Conversation
  method: PATCH
  title: Updates the Conversation resource.
  returns: Conversation
supported operation: Updates the Conversation resource.
  type: Operation
  expects: Conversation
  method: PATCH
  title: Updates the Conversation resource.
  returns: Conversation
supported operation: Retrieves the collection of Message resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Message resources.
  returns: Message

type
type: Property
domain: Conversation
range: integer

name
type: Property
domain: Conversation
range: string

externalUser
type: Property
domain: Conversation
max cardinality: 1
range: ExternalUser

dashboardUuid
type: Property
domain: Conversation

workBotConversationUuid
type: Property
domain: Conversation
range: string

respondedAt
type: Property
domain: Conversation
range: dateTime

topic
type: Property
domain: Conversation
range: string

description
type: Property
domain: Conversation
range: string

requestedAt
type: Property
domain: Conversation
range: dateTime

closedAt
type: Property
domain: Conversation
range: dateTime

language
type: Property
domain: Conversation
range: string

created
type: Property
domain: Conversation
range: dateTime

updated
type: Property
domain: Conversation
range: dateTime

closed
type: Property
domain: Conversation
range: boolean

Message
type: Class
title: Message
supported property: SupportedProperty
  property: isInternalUser
  title: isInternalUser
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: content
  title: content
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: files
  title: files
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: creator
  title: creator
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: created
  title: created
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: edited
  title: edited
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: childCount
  title: childCount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: videoRoom
  title: videoRoom
  required: false
  readable: true
  writeable: true
supported operation: Retrieves Message resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Message resource.
  returns: Message
supported operation: Updates the Message resource.
  type: Operation
  expects: Message
  method: PATCH
  title: Updates the Message resource.
  returns: Message
supported operation: Deletes the Message resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Message resource.
  returns: Nothing
supported operation: Retrieves Message resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Message resource.
  returns: Message
supported operation: Creates a Message resource.
  type: Operation
  type: CreateAction
  expects: Message
  method: POST
  title: Creates a Message resource.
  returns: Message

isInternalUser
type: Property
domain: Message
range: boolean

content
type: Property
domain: Message
range: string

files
type: Property
domain: Message
range: MessageFile

creator
type: Property
domain: Message

created
type: Property
domain: Message
range: dateTime

edited
type: Property
domain: Message
range: boolean

childCount
type: Property
domain: Message
range: integer

videoRoom
type: Property
domain: Message
max cardinality: 1
range: VideoRoom

UserMessage
type: Class
title: UserMessage
supported property: SupportedProperty
  property: message
  title: message
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: seen
  title: seen
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: unSeenMessagesCount
  title: unSeenMessagesCount
  required: false
  readable: true
  writeable: false
  description: Unseen child messages count
supported property: SupportedProperty
  property: unSeenMentionedRepliesCount
  title: unSeenMentionedRepliesCount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: mentionType
  title: mentionType
  required: false
  readable: true
  writeable: false
supported operation: Retrieves UserMessage resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves UserMessage resource.
  returns: UserMessage
supported operation: Updates the UserMessage resource.
  type: Operation
  expects: UserMessage
  method: PATCH
  title: Updates the UserMessage resource.
  returns: UserMessage

message
type: Property
domain: UserMessage
max cardinality: 1
range: Message

seen
type: Property
domain: UserMessage
range: boolean

unSeenMessagesCount
type: Property
domain: UserMessage
range: integer

unSeenMentionedRepliesCount
type: Property
domain: UserMessage
range: integer

mentionType
type: Property
domain: UserMessage
range: integer

ConversationUser
type: Class
title: ConversationUser
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: unSeenMessagesCount
  title: unSeenMessagesCount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: unSeenChildMessagesCount
  title: unSeenChildMessagesCount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: unSeenMentionedCount
  title: unSeenMentionedCount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: unSeenMentionedChildCount
  title: unSeenMentionedChildCount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: joined
  title: joined
  required: false
  readable: true
  writeable: false
supported operation: Retrieves ConversationUser resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves ConversationUser resource.
  returns: ConversationUser
supported operation: Updates the ConversationUser resource.
  type: Operation
  expects: ConversationUser
  method: PATCH
  title: Updates the ConversationUser resource.
  returns: ConversationUser
supported operation: Deletes the ConversationUser resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the ConversationUser resource.
  returns: Nothing
supported operation: Creates a ConversationUser resource.
  type: Operation
  type: CreateAction
  expects: ConversationUser
  method: POST
  title: Creates a ConversationUser resource.
  returns: ConversationUser
supported operation: Updates the ConversationUser resource.
  type: Operation
  expects: ConversationUser
  method: PATCH
  title: Updates the ConversationUser resource.
  returns: ConversationUser

user
type: Property
domain: ConversationUser

unSeenMessagesCount
type: Property
domain: ConversationUser
range: integer

unSeenChildMessagesCount
type: Property
domain: ConversationUser
range: integer

unSeenMentionedCount
type: Property
domain: ConversationUser
range: integer

unSeenMentionedChildCount
type: Property
domain: ConversationUser
range: integer

joined
type: Property
domain: ConversationUser
range: boolean

VideoRoomRequest
type: Class
title: VideoRoomRequest
supported property: SupportedProperty
  property: creator
  title: creator
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: assignee
  title: assignee
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: dashboardUuid
  title: dashboardUuid
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: acceptedBy
  title: acceptedBy
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: created
  title: created
  required: false
  readable: true
  writeable: false
supported operation: Retrieves VideoRoomRequest resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves VideoRoomRequest resource.
  returns: VideoRoomRequest
supported operation: Updates the VideoRoomRequest resource.
  type: Operation
  expects: VideoRoomRequest
  method: PATCH
  title: Updates the VideoRoomRequest resource.
  returns: VideoRoomRequest
supported operation: Deletes the VideoRoomRequest resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the VideoRoomRequest resource.
  returns: Nothing

creator
type: Property
domain: VideoRoomRequest

description
type: Property
domain: VideoRoomRequest
range: string

assignee
type: Property
domain: VideoRoomRequest
max cardinality: 1
range: User

type
type: Property
domain: VideoRoomRequest
range: integer

dashboardUuid
type: Property
domain: VideoRoomRequest

acceptedBy
type: Property
domain: VideoRoomRequest
max cardinality: 1
range: User

created
type: Property
domain: VideoRoomRequest
range: dateTime

ChatRequest
type: Class
title: ChatRequest
supported property: SupportedProperty
  property: creator
  title: creator
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: dashboardUuid
  title: dashboardUuid
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: acceptedBy
  title: acceptedBy
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: created
  title: created
  required: false
  readable: true
  writeable: false
supported operation: Retrieves ChatRequest resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves ChatRequest resource.
  returns: ChatRequest
supported operation: Updates the ChatRequest resource.
  type: Operation
  expects: ChatRequest
  method: PATCH
  title: Updates the ChatRequest resource.
  returns: ChatRequest

creator
type: Property
domain: ChatRequest
max cardinality: 1
range: ExternalUser

dashboardUuid
type: Property
domain: ChatRequest

acceptedBy
type: Property
domain: ChatRequest
max cardinality: 1
range: User

created
type: Property
domain: ChatRequest
range: dateTime

CallReview
type: Class
title: CallReview
supported property: SupportedProperty
  property: creator
  title: creator
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: rating
  title: rating
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: comment
  title: comment
  required: false
  readable: true
  writeable: true
supported operation: Retrieves CallReview resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves CallReview resource.
  returns: CallReview

creator
type: Property
domain: CallReview

rating
type: Property
domain: CallReview
range: integer

comment
type: Property
domain: CallReview
range: string

VideoRecording
type: Class
title: VideoRecording
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: created
  title: created
  required: false
  readable: true
  writeable: false
supported operation: Retrieves VideoRecording resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves VideoRecording resource.
  returns: VideoRecording
supported operation: Deletes the VideoRecording resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the VideoRecording resource.
  returns: Nothing

status
type: Property
domain: VideoRecording
range: string

created
type: Property
domain: VideoRecording
range: dateTime

ExternalUser
type: Class
title: ExternalUser
supported property: SupportedProperty
  property: fullName
  title: fullName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: phone
  title: phone
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: whatsappPhone
  title: whatsappPhone
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: timeZone
  title: timeZone
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: online
  title: online
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: false
supported operation: Retrieves ExternalUser resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves ExternalUser resource.
  returns: ExternalUser
supported operation: Updates the ExternalUser resource.
  type: Operation
  expects: ExternalUser
  method: PATCH
  title: Updates the ExternalUser resource.
  returns: ExternalUser

fullName
type: Property
domain: ExternalUser
range: string

email
type: Property
domain: ExternalUser
range: string

phone
type: Property
domain: ExternalUser
range: string

whatsappPhone
type: Property
domain: ExternalUser
range: string

timeZone
type: Property
domain: ExternalUser
range: string

online
type: Property
domain: ExternalUser
range: boolean

type
type: Property
domain: ExternalUser

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

MediaObject
type: Class
title: MediaObject
supported property: SupportedProperty
  property: fileName
  title: fileName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: originalName
  title: originalName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: created
  title: created
  required: false
  readable: true
  writeable: false
supported operation: Retrieves MediaObject resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves MediaObject resource.
  returns: MediaObject

fileName
type: Property
domain: MediaObject
range: string

originalName
type: Property
domain: MediaObject
range: string

created
type: Property
domain: MediaObject
range: dateTime

UserMessageReaction
type: Class
title: UserMessageReaction
supported property: SupportedProperty
  property: reactionId
  title: reactionId
  required: true
  readable: true
  writeable: true
  description: TODO Check why unicode are not properly working
supported property: SupportedProperty
  property: userUuid
  title: userUuid
  required: false
  readable: true
  writeable: false
supported operation: Retrieves UserMessageReaction resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves UserMessageReaction resource.
  returns: UserMessageReaction
supported operation: Updates the UserMessageReaction resource.
  type: Operation
  expects: UserMessageReaction
  method: PATCH
  title: Updates the UserMessageReaction resource.
  returns: UserMessageReaction
supported operation: Deletes the UserMessageReaction resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the UserMessageReaction resource.
  returns: Nothing

reactionId
type: Property
domain: UserMessageReaction
range: string

userUuid
type: Property
domain: UserMessageReaction

MissedCall
type: Class
title: MissedCall
supported property: SupportedProperty
  property: caller
  title: caller
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: called
  title: called
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: created
  title: created
  required: false
  readable: true
  writeable: false
supported operation: Retrieves MissedCall resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves MissedCall resource.
  returns: MissedCall

caller
type: Property
domain: MissedCall

called
type: Property
domain: MissedCall

created
type: Property
domain: MissedCall
range: dateTime

DialedCall
type: Class
title: DialedCall
supported property: SupportedProperty
  property: caller
  title: caller
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: called
  title: called
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: room
  title: room
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: start
  title: start
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: end
  title: end
  required: false
  readable: true
  writeable: true
supported operation: Retrieves DialedCall resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves DialedCall resource.
  returns: DialedCall

caller
type: Property
domain: DialedCall

called
type: Property
domain: DialedCall

room
type: Property
domain: DialedCall
max cardinality: 1
range: VideoRoom

start
type: Property
domain: DialedCall
range: dateTime

end
type: Property
domain: DialedCall
range: dateTime

AttendanceExportRequest
type: Class
title: AttendanceExportRequest
supported property: SupportedProperty
  property: company
  title: company
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: requestedFor
  title: requestedFor
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: integrationType
  title: integrationType
  required: false
  readable: true
  writeable: true
supported operation: Retrieves AttendanceExportRequest resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves AttendanceExportRequest resource.
  returns: AttendanceExportRequest

company
type: Property
domain: AttendanceExportRequest
max cardinality: 1
range: Company

requestedFor
type: Property
domain: AttendanceExportRequest
range: dateTime

integrationType
type: Property
domain: AttendanceExportRequest
range: integer

ExternalCustomer
type: Class
title: ExternalCustomer
supported property: SupportedProperty
  property: firstName
  title: firstName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: lastName
  title: lastName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: phone
  title: phone
  required: false
  readable: true
  writeable: false
supported operation: Retrieves ExternalCustomer resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves ExternalCustomer resource.
  returns: ExternalCustomer

firstName
type: Property
domain: ExternalCustomer
range: string

lastName
type: Property
domain: ExternalCustomer
range: string

email
type: Property
domain: ExternalCustomer
range: string

phone
type: Property
domain: ExternalCustomer
range: string

SignatureRequest
type: Class
title: SignatureRequest
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updated
  title: updated
  required: false
  readable: true
  writeable: false
supported operation: Retrieves SignatureRequest resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves SignatureRequest resource.
  returns: SignatureRequest

name
type: Property
domain: SignatureRequest
range: string

status
type: Property
domain: SignatureRequest
range: integer

updated
type: Property
domain: SignatureRequest
range: dateTime

Entrypoint
type: Class
title: The API entrypoint
supported property: SupportedProperty
  property: The collection of User resources
  title: The collection of User resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of VideoRoom resources
  title: The collection of VideoRoom resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Company resources
  title: The collection of Company resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of UserCompanyProfile resources
  title: The collection of UserCompanyProfile resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Conversation resources
  title: The collection of Conversation resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Message resources
  title: The collection of Message resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of UserMessage resources
  title: The collection of UserMessage resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ConversationUser resources
  title: The collection of ConversationUser resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of VideoRoomRequest resources
  title: The collection of VideoRoomRequest resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ChatRequest resources
  title: The collection of ChatRequest resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of CallReview resources
  title: The collection of CallReview resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of VideoRecording resources
  title: The collection of VideoRecording resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ExternalUser resources
  title: The collection of ExternalUser resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of MediaObject resources
  title: The collection of MediaObject resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of UserMessageReaction resources
  title: The collection of UserMessageReaction resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of MissedCall resources
  title: The collection of MissedCall resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of DialedCall resources
  title: The collection of DialedCall resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of AttendanceExportRequest resources
  title: The collection of AttendanceExportRequest resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ExternalCustomer resources
  title: The collection of ExternalCustomer resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of SignatureRequest resources
  title: The collection of SignatureRequest resources
  readable: true
  writeable: false
supported operation: The API entrypoint.
  type: Operation
  method: GET
  returns: EntryPoint

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

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

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

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

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

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

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

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

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

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

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

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

The collection of ExternalUser resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ExternalUser
supported operation: Deletes the ExternalUser resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the ExternalUser resource.
  returns: Nothing

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

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

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

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

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

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

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

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

propertyPath
type: Property
domain: ConstraintViolation
range: string

message
type: Property
domain: ConstraintViolation
range: string

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

violations
type: Property
domain: ConstraintViolationList
range: ConstraintViolation