Communication Templates

Get a communication template

Receive a specific communication template. A deleted template is returned too, with status deleted and deleted_at and deleted_by set.

Message, subject, button text, footer and SMS fields that are empty on the template are returned filled with the default text in the template's language. Sending the response back with Update a communication template therefore saves that default text on the template.

get/v1/communication-templates/{communicationTemplateId}

Request

  • Base URL: https://api.getaccept.com
  • URL: https://api.getaccept.com/v1/communication-templates/{communicationTemplateId}
  • Auth: HTTP bearer

Path parameters

communicationTemplateIdstring required

Id of the communication template.

Response

The request succeeded.

idstring required

Id of the communication template.

entity_idstring required

Id of the entity that owns the communication template.

namestring required

Name of the communication template.

languagestring required

Language of the template as an ISO 639 code, for example en or sv.

created_bystring required

Id of the user that created the communication template.

updated_bystring required

Id of the user that last updated the communication template.

tagsstring[]

Tags of the communication template.

created_atstring required

When the communication template was created.

updated_atstring required

When the communication template was last updated.

status'draft' | 'published' | 'deleted' required

Status of the template: published, draft or deleted. A deleted template can still be read by id.

deleted_atnumber

When the communication template was deleted, in epoch milliseconds, unlike created_at and updated_at. Only present on templates that were deleted.

deleted_bystring

Id of the user that deleted the communication template.

type'default' | 'none' required

Kind of communication template.

Changes

No recorded changes to this operation across all 1 revision of this API.