Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateWhatsAppMessageTemplate

Creates a new WhatsApp message template from a custom definition.

Note

AWS End User Messaging Social does not store any WhatsApp message template content.

Request Syntax


POST /v1/whatsapp/template/put HTTP/1.1
Content-type: application/json

{
   "id": "string",
   "templateDefinition": blob
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

id

The ID of the WhatsApp Business Account to associate with this template.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: .*(^waba-.*$)|(^arn:.*:waba/[0-9a-zA-Z]+$).*

Required: Yes

templateDefinition

The complete template definition as a JSON blob.

Type: Base64-encoded binary data object

Length Constraints: Minimum length of 1. Maximum length of 6000.

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "category": "string",
   "metaTemplateId": "string",
   "templateStatus": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

category

The category of the template, such as UTILITY or MARKETING.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

metaTemplateId

The numeric ID assigned to the template by Meta.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [0-9]+

templateStatus

The status of the created template, such as PENDING or APPROVED..

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

DependencyException

Thrown when performing an action because a dependency would be broken.

HTTP Status Code: 502

InternalServiceException

The request processing has failed because of an unknown error, exception, or failure.

HTTP Status Code: 500

InvalidParametersException

One or more parameters provided to the action are not valid.

HTTP Status Code: 400

ResourceNotFoundException

The resource was not found.

HTTP Status Code: 404

ThrottledRequestException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The request contains an invalid parameter value.

HTTP Status Code: 400