Amazon Pinpoint
REST API Reference

SMS Template

An SMS template is a type of message template that contains content that you can define, save, and reuse in messages that you send through the SMS channel for any of your Amazon Pinpoint applications. You can use SMS templates in campaign messages, transactional messages, direct messages, and test messages.

When you create an SMS template, you specify the content that you want to reuse in the body of messages that are based on the template. When you then send a message that’s based on the template, Amazon Pinpoint populates the message with the content that you defined in the template.

The SMS Template resource represents the repository of SMS templates that are associated with your Amazon Pinpoint account. You can use this resource to create, retrieve, update, or delete a message template for messages that you send through the SMS channel.

URI

/v1/templates/template-name/sms

HTTP Methods

GET

Operation ID: GetSmsTemplate

Retrieves the content and settings for a message template that you can use in messages that are sent through the SMS channel.

Path Parameters

Name Type Required Description
template-name String True

The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

Header Parameters

Name Type Required Description
accept String False

Indicates which content types, expressed as MIME types, the client understands.

Responses

Status Code Response Model Description
200 SMSTemplateResponse

The request succeeded.

400 MessageBody

The request contains a syntax error (BadRequestException).

403 MessageBody

The request was denied because access to the specified resource is forbidden (ForbiddenException).

404 MessageBody

The request failed because the specified resource was not found (NotFoundException).

405 MessageBody

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

429 MessageBody

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

500 MessageBody

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

POST

Operation ID: CreateSmsTemplate

Creates a message template that you can use in messages that are sent through the SMS channel.

Path Parameters

Name Type Required Description
template-name String True

The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

Header Parameters

Name Type Required Description
accept String False

Indicates which content types, expressed as MIME types, the client understands.

Responses

Status Code Response Model Description
201 CreateTemplateMessageBody

The request succeeded and the specified resource was created.

400 MessageBody

The request contains a syntax error (BadRequestException).

403 MessageBody

The request was denied because access to the specified resource is forbidden (ForbiddenException).

405 MessageBody

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

429 MessageBody

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

500 MessageBody

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

PUT

Operation ID: UpdateSmsTemplate

Updates an existing message template that you can use in messages that are sent through the SMS channel.

Path Parameters

Name Type Required Description
template-name String True

The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

Header Parameters

Name Type Required Description
accept String False

Indicates which content types, expressed as MIME types, the client understands.

Responses

Status Code Response Model Description
202 MessageBody

The request was accepted for processing. Processing may not be complete.

400 MessageBody

The request contains a syntax error (BadRequestException).

403 MessageBody

The request was denied because access to the specified resource is forbidden (ForbiddenException).

404 MessageBody

The request failed because the specified resource was not found (NotFoundException).

405 MessageBody

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

429 MessageBody

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

500 MessageBody

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

DELETE

Operation ID: DeleteSmsTemplate

Deletes a message template that was designed for use in messages that were sent through the SMS channel.

Path Parameters

Name Type Required Description
template-name String True

The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

Header Parameters

Name Type Required Description
accept String False

Indicates which content types, expressed as MIME types, the client understands.

Responses

Status Code Response Model Description
202 MessageBody

The request was accepted for processing. Processing may not be complete.

400 MessageBody

The request contains a syntax error (BadRequestException).

403 MessageBody

The request was denied because access to the specified resource is forbidden (ForbiddenException).

404 MessageBody

The request failed because the specified resource was not found (NotFoundException).

405 MessageBody

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

429 MessageBody

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

500 MessageBody

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

OPTIONS

Retrieves information about the communication requirements and options that are available for the SMS Template resource.

Responses

Status Code Response Model Description
200 None

The request succeeded.

Schemas

Request Bodies

Example POST

{ "tags": { }, "Body": "string" }

Example PUT

{ "tags": { }, "Body": "string" }

Response Bodies

Example SMSTemplateResponse

{ "CreationDate": "string", "LastModifiedDate": "string", "TemplateType": enum, "TemplateName": "string", "tags": { }, "Arn": "string", "Body": "string" }

Example CreateTemplateMessageBody

{ "RequestID": "string", "Message": "string", "Arn": "string" }

Example MessageBody

{ "RequestID": "string", "Message": "string" }

Properties

CreateTemplateMessageBody

Provides information about a request to create a message template.

Property Type Required Description
RequestID

string

False

The unique identifier for the request to create the message template.

Message

string

False

The message that's returned from the API for the request to create the message template.

Arn

string

False

The Amazon Resource Name (ARN) of the message template that was created.

MessageBody

Provides information about an API request or response.

Property Type Required Description
RequestID

string

False

The unique identifier for the request or response.

Message

string

False

The message that's returned from the API.

SMSTemplateRequest

Specifies the content and settings for a message template that can be used in text messages that are sent through the SMS channel.

Property Type Required Description
tags

object

False

A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

Body

string

False

The message body to use in text messages that are based on the message template.

SMSTemplateResponse

Provides information about the content and settings for a message template that can be used in text messages that are sent through the SMS channel.

Property Type Required Description
CreationDate

string

True

The date when the message template was created.

LastModifiedDate

string

True

The date when the message template was last modified.

TemplateType

string

Values: EMAIL | SMS | VOICE | PUSH

True

The type of channel that the message template is designed for. For an SMS template, this value is SMS.

TemplateName

string

True

The name of the message template.

tags

object

False

A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.

Arn

string

False

The Amazon Resource Name (ARN) of the message template.

Body

string

False

The message body that's used in text messages that are based on the message template.

See Also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

GetSmsTemplate

CreateSmsTemplate

UpdateSmsTemplate

DeleteSmsTemplate