Agendize Developers API

Home > Agendize Scheduling

Calendar Templates

Resource representation

{ "action": {string}, "name": {string}, "recipientType": {string}, "languages": { {string}: { "id": {string}, "summary": {string}, "description": {string}, "location": {string}, "locationCustom": {string}, "default": {boolean} } } "default": {boolean} }
Parameter name Value Description
action string Type of action. Values: "contactEvent", "staffEvent".
name string Name of the calendar template. Read-only.
languages object Languages of the calendar template. Values: "en", "fr", "de", "es", "pt", "it".
languages[language].id string Identifier of calendar template.
languages[language].summary string Summary of the calendar template.
languages[language].description string Description of the calendar template.
languages[language].location string Location type. Values: "companyAddress", "videoconference", "custom"
languages[language].locationCustom string Custom string location.
default boolean If the content of the calendar template is a default calendar template. Read-only

Delete

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

Request

HTTP Request

DELETE https://api.agendize.com/api/2.3/scheduling/companies/{companyId}/settings/templates/calendars/{action}

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.
action string Action of the calendar template.

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.3/scheduling/companies/{companyId}/settings/templates/calendars/{action}

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.
action string Action of the calendar template.
Optional query parameters
language string language for template details. Default value: "en".

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a Calendar 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.3/scheduling/settings/templates/calendars

Parameters

Parameter name Value Description
Required query parameters
companyId string Company identifier.
Optional query parameters
language string language for template details. Default value: "en".

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: [Calendar Template Resource, without "language" field.] }

Update

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

Request

HTTP Request

PUT https://api.agendize.com/api/2.3/scheduling/companies/{companyId}/settings/templates/calendars/{action}

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.
action string Action of the calendar template.
Optional query parameters
language string language for template details. Default value: "en".

Request body

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

Parameter name Value Description
Optional Properties
name string Name of the calendar template.
languages object Languages of the calendar template. Values: "en", "fr", "de", "es", "pt", "it".
languages[language].id string Identifier of calendar template.
languages[language].summary string Summary of the calendar template.
languages[language].description string Description of the calendar template.
languages[language].location string Location type. Values: "companyAddress", "videoconference", "custom"
languages[language].locationCustom string Custom string location.

Response

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

Agendize | Support | Status

Last update: Nov 12, 2025 - Copyright © 2025 Agendize. All rights reserved.