| Parameter name | Value | Description |
|---|---|---|
id |
string |
Identifier of the attendee. |
status |
string |
Status of the attendee. Values: "accepted", "declined". |
type |
string |
Type of the attendee. Values: "client", "user", "staff". |
client.id |
string |
Identifier of the client |
client.firstName |
string |
First name of the client |
client.lastName |
string |
Last name of the client |
client.emailAddress |
string |
Primary email address of the client |
client.mobilePhoneNumber |
string |
Mobile phone number of the client |
client.picture |
object |
Staff picture url and mime type. Read-only |
client.picture.url |
string |
Url of the client picture. |
client.picture.mimeType |
string |
Mime type of the client picture file. |
client.externalId |
string |
External identifier of the client. |
Deletes an entry on the user's company list.
Authentication is required to execute this request. Please refer to Authentication for more.
| Parameter name | Value | Description |
|---|---|---|
| Path parameters | ||
appointmentId |
string |
Appointment identifier or appointment reference. |
attendeeId |
string |
Appointment attendee identifier. |
| Optional query parameters | ||
fields |
string |
Specify the fields returned. Comma separated field names (ex: "id,type"). |
Do not supply a request body with this method.
If successful, this method returns an empty response body.
Returns an entry of the user's company list.
Authentication is required to execute this request. Please refer to Authentication for more.
| Parameter name | Value | Description |
|---|---|---|
| Path parameters | ||
appointmentId |
string |
Appointment identifier or appointment reference. |
attendeeId |
string |
Appointment attendee identifier. |
| Optional query parameters | ||
fields |
string |
Specify the fields returned. Comma separated field names (ex: "id,type"). |
Do not supply a request body with this method.
If successful, this method returns a Attendee resource in the response body.
Returns entries on the company list.
Authentication is required to execute this request. Please refer to Authentication for more.
| Parameter name | Value | Description |
|---|---|---|
| Path parameters | ||
appointmentId |
string |
Appointment identifier or appointment reference. |
| Optional query parameters | ||
fields |
string |
Specify the fields returned. Comma separated field names (ex: "id,type"). |
Do not supply a request body with this method.
If successful, this method returns a response body with the following structure:
Adds an entry to the user's company list.
Authentication is required to execute this request. Please refer to Authentication for more.
In the request body, supply a Attendee resource with the following properties:
| Parameter name | Value | Description |
|---|---|---|
| Required Properties | ||
type |
string |
Type of the attendee. Values: "client", "user", "staff". |
client.id |
string |
Identifier of the client. Required if the type of appointment is "client". |
If successful, this method returns a Attendee resource in the response body.
Updates an entry on the user's company list.
Authentication is required to execute this request. Please refer to Authentication for more.
| Parameter name | Value | Description |
|---|---|---|
| Path parameters | ||
appointmentId |
string |
Appointment identifier or appointment reference. |
attendeeId |
string |
Appointment attendee identifier. |
In the request body, supply a Attendee resource with the following properties:
| Parameter name | Value | Description |
|---|---|---|
| Optional Properties | ||
status |
string |
Status of the attendee. Values: "accepted", "declined". |
If successful, this method returns a Attendee resource in the response body.