Agendize Developers API

Home > Agendize Scheduling

Scheduling Text Message Templates

Resource representation

{ "id": {string}, "name": {string}, "text": {string}, "action": {string}, "language": {string} }
Parameter name Value Description
id string Identifier of the message template.
name string Name of the message template. Writable. Max length: 127.
text string Text body of the message template. Writable. Max length: 65535
action string
action string Type of appointment action/event.
  • clientNewAppointment
  • clientNewAppointmentPending
  • clientReminder
  • clientCancel
  • clientAppointmentDeclined
  • client
  • clientInvitation
  • staffNewAppointment
  • managerNewAppointment
  • managerNewAppointmentValidation
  • managerAppointmentCancelled
  • managerRescheduledAppointmentValidation
  • staffInvitationSynchronization
  • staffReminder
  • staffDaily
  • clientAppointmentCompleted
  • clientDashboardAppointmentRescheduled
  • clientWidgetAppointmentCancelled
  • staffRescheduledAppointmentValidation
  • managerAppointmentDeclined
  • managerStaffDashboardAppointmentCancelled
  • managerStaffDashboardAppointmentRescheduled
  • clientAppointmentFinished
  • clientWidgetAppointmentRescheduled
  • clientPaymentReminder
  • staffAppointmentRescheduled
  • clientWaitingListFree
language string Language of the template. Supported languages: en, fr, es, de, pt, nl.

Delete

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

Request

HTTP Request

DELETE https://api.agendize.com/api/2.1/scheduling/companies/{companyId}/settings/messages/sms/{templateId}

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.
templateId string Message Template identifier.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns an empty response body.

Get

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

Request

HTTP Request

GET https://api.agendize.com/api/2.1/scheduling/companies/{companyId}/settings/messages/sms/{templateId}

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.
templateId string Message Template identifier.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a Message Template in the response body.

List

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

Request

HTTP Request

GET https://api.agendize.com/api/2.1/scheduling/companies/{companyId}/settings/messages/sms

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:

{ items: [Message Template Resource] }

List

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

Request

HTTP Request

GET https://api.agendize.com/api/2.1/scheduling/companies/{companyId}/settings/messages/defaultSMS

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.
Optional query parameters
language string Language code.

Request body

Do not supply a request body with this method.

Response

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

{ items: [Message Template Resource] }

Insert

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

Request

HTTP Request

POST https://api.agendize.com/api/2.1/scheduling/companies/{companyId}/settings/messages/sms

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.

Request body

In the request body, supply a Message Template Resource with the following properties:

Parameter name Value Description
Required Properties
name string Name of the message template.
text string Text body of the message template.
action string Type of appointment action/event.

Response

If successful, this method returns a Message Template in the response body.

Update

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

Request

HTTP Request

PUT https://api.agendize.com/api/2.1/scheduling/companies/{companyId}/settings/messages/sms/{templateId}

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.
templateId string Template identifier.

Request body

In the request body, supply a Message Template Resource with the following properties:

Parameter name Value Description
Optional Properties
name string Name of the message template.
text string Text body of the message template.

Response

If successful, this method returns a Message Template Resource in the response body.

Agendize | Support | Status

Last update: Oct 15, 2024 - Copyright © 2024 Agendize. All rights reserved.