| Parameter name | Value | Description |
|---|---|---|
id |
string |
Identifier of the appointment. |
type |
string |
Type of the message. Values: "email" or "sms". |
event |
object |
Appointment link to the message. |
event.id |
string |
Identifier of the appointment. |
event.selfLink |
string |
API link to the appointment. |
date |
object |
The send date of the message. |
date.dateTime |
string |
The time, as a combined date-time value (formatted according to RFC 3339, without time zone information). |
date.timeZone |
string |
The time zone. Possible values can be found here. The default value is the time zone of the company. |
recipients[] |
list |
Recipients of the message. |
recipients[].id |
string |
Identifier of the recipient. |
recipients[].emailAddress |
string |
Email address of the recipient, if the message is an email. |
recipients[].phoneNumber |
string |
Phone number of the recipient, if the message is a text message. |
content |
object |
Content of the message. |
content.content |
string |
Text of the message. |
content.mimeType |
string |
Mime type of the message. values: "text" or "html". |
content.subject |
string |
Subject of the message. Only for email message. |
Authentication is required to execute this request. Please refer to Authentication for more.
| Parameter name | Value | Description |
|---|---|---|
| Path parameters | ||
companyId |
string |
Company identifier. |
Do not supply a request body with this method.
If successful, this method returns a response body with the following structure:
Watch for email and text message notifications sent.
Authentication is required to execute this request. Please refer to Authentication for more.
| Parameter name | Value | Description |
|---|---|---|
id |
string |
Identifier of the watch. |
address |
string |
The address where notifications are delivered for this watch. |
If successful, this method returns an of Watch resource in the response body.