object property
object
object Type
object
(Details)
object Properties
Property | Type | Required | Nullable | Defined by |
---|---|---|---|---|
uid | string |
Required | cannot be null | object |
eventTypeUid | string |
Required | cannot be null | object |
status | string |
Required | cannot be null | object |
timeZone | string |
Required | cannot be null | object |
createdAt | string |
Required | cannot be null | object |
updatedAt | string |
Required | cannot be null | object |
startedAt | string |
Required | cannot be null | object |
endedAt | string |
Required | cannot be null | object |
cancelReason | string |
Required | can be null | object |
cancelledAt | string |
Required | can be null | object |
cancelledBy | string |
Required | can be null | object |
contact | object |
Required | cannot be null | contact |
answers | array |
Required | cannot be null | answers |
tracking | object |
Required | cannot be null | tracking |
uid
Event id(unique identifier)
uid
is required
Type:
string
cannot be null
defined in: object
uid Type
string
eventTypeUid
Event type id(unique identifier)
eventTypeUid
is required
Type:
string
cannot be null
defined in: object
eventTypeUid Type
string
status
Event status
status
is required
Type:
string
cannot be null
defined in: object
status Type
string
status Constraints
enum: the value of this property must be equal to one of the following values:
Value | Explanation |
---|---|
"open" |
Event is open |
"cancel" |
Event was canceled |
timeZone
Timezone which a guest selected
timeZone
is required
Type:
string
cannot be null
defined in: object
timeZone Type
string
timeZone Examples
"Asia/Tokyo"
createdAt
The time event was created
createdAt
is required
Type:
string
cannot be null
defined in: object
createdAt Type
string
createdAt Constraints
date time: the string must be a date time string, according to RFC 3339, section 5.6
createdAt Examples
"2019-08-24T10:01:01.000Z"
updatedAt
The time event was last updated
updatedAt
is required
Type:
string
cannot be null
defined in: object
updatedAt Type
string
updatedAt Constraints
date time: the string must be a date time string, according to RFC 3339, section 5.6
updatedAt Examples
"2019-08-24T10:02:02.000Z"
startedAt
The time event was started
startedAt
is required
Type:
string
cannot be null
defined in: object
startedAt Type
string
startedAt Constraints
date time: the string must be a date time string, according to RFC 3339, section 5.6
startedAt Examples
"2019-08-24T14:00:00.000Z"
endedAt
The time event was ended
endedAt
is required
Type:
string
cannot be null
defined in: object
endedAt Type
string
endedAt Constraints
date time: the string must be a date time string, according to RFC 3339, section 5.6
endedAt Examples
"2019-08-24T15:00:00.000Z"
cancelReason
The reason that the cancellation occurred
cancelReason
is required
Type:
string
can be null
defined in: object
cancelReason Type
string
cancelReason Examples
"Another meeting scheduled"
cancelledAt
The time event was cancellled
cancelledAt
is required
Type:
string
can be null
defined in: object
cancelledAt Type
string
cancelledAt Constraints
date time: the string must be a date time string, according to RFC 3339, section 5.6
cancelledAt Examples
"2019-08-294T14:01:01.000Z"
cancelledBy
Status of Cancelled by guest or host
cancelledBy
is required
Type:
string
can be null
defined in: object
cancelledBy Type
string
cancelledBy Constraints
enum: the value of this property must be equal to one of the following values:
Value | Explanation |
---|---|
"guest" |
Canceled by guest |
"host" |
Canceled by host |
cancelledBy Examples
"host"
contact
The guest data
contact
object
(Details)
answers
The collection of the guest's responses to questions
answers
answers Type
object[]
(Details)
tracking
The UTM tracking parameters associated with the guest
tracking
tracking Type
object
(Details)