Home > Agendize Scheduling

Notifications


Resource representation

{ "appointment": { "id": {string}, "selfLink": {string} }, content: { "content": {string}, "mineType": {string} "subject": (string} }, "date": { "dateTime": {datetime}, "timeZone": {string} }, "recipients": [ { type: {string}, emailAddress: {string}, phoneNumber: {string} } ], type: {string} }
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.

List

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

GET http://az2.agendize.com/api/2.0/scheduling/companies/{companyId}/notifications

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:


Watch

Watch for email and text message notifications sent.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

POST http://az2.agendize.com/api/2.0/scheduling/companies/{companyId}/notifications/watch

Request body

{ "id": {string}, "address": {string} }
Parameter name Value Description
id string Identifier of the watch.
address string The address where notifications are delivered for this watch.

Response

If successful, this method returns an of Watch resource in the response body.