Sign in
MessageTemplate

Get message template by ID

get/api/ext/v3/messageTemplates/{template_id}

Path parameters

template_idstring required

The unique identifier of the message template to retrieve.

Response

Returns the message template.

idstring nullable

The unique identifier of the message template.

namestring nullable

The name of the message template.

categorystring nullable

The category of the template.

sub_categorystring nullable

The subcategory of the template.

hsmstring nullable

The HSM (Highly Structured Message) content.

hsm_originalstring nullable

The original HSM content.

statusstring nullable

The current status of the template.

last_modifiedstring date-time

The last modification date of the template.

typestring nullable

The type of the message template.

bodystring nullable

The body content of the template.

body_originalstring nullable

The original body content of the template.

footerstring nullable

The footer content of the template.

buttons_typestring nullable

The type of buttons used in the template.

expires_ininteger

Expiration time in seconds.

include_expiry_timeboolean

Whether to include expiry time.

add_security_recommendationboolean

Whether to add security recommendation.

is_url_btn_click_tracking_enabledboolean

Whether URL button click tracking is enabled.

qualitystring nullable

The quality rating of the template.

creation_methodstring nullable

The method used to create the template.

Changes

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