PUT

/v1/templates/{template-name}/{template-type}/active-version

http://pinpoint.{region}.amazonaws.com/v1/templates/{template-name}/{template-type}/active-version

Changes the status of a specific version of a message template to <i>active</i>.

Access Token Required: API Key

Path Parameters

template-namestringrequired

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.

template-typestringrequired

The type of channel that the message template is designed for. Valid values are: EMAIL, PUSH, SMS, and VOICE.

Body Params

TemplateActiveVersionRequestobjectrequired

Specifies which version of a message template to use as the active version of the template.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PUT \
2     --url 'http://pinpoint.{region}.amazonaws.com/v1/templates/{template-name}/{template-type}/active-version' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}