Skip to navigation

List templates

Retrieves the active templates of the account of the authenticated API Key. Use the id field as template_id when sending a message. If the account has no templates, an empty array is returned.

Authentication

x-api-keystring

Account authentication key. The App-Key must have the RCS channel enabled.

OR
AuthorizationBearer

OAuth 2.0 access token issued by POST /api/oauth/token (client-credentials). Takes precedence over x-api-key when both are sent. See the Authentication section.

Response

List of active templates.
idstringOptional

Template identifier. Use it as template_id when sending a message.

namestringOptional
accountstringOptional

Owner account (informational).

statusbooleanOptional

Always true; only active templates are listed.

typeenumOptional
RCS content type. The agent's type must match the template's type when sending.
Allowed values:
created_atdatetimeOptional
updated_atdatetimeOptional

Errors

401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error