{ "opencollection": "1.0.0", "info": { "name": "Amazon Pinpoint Applications Templates API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Templates", "type": "folder" }, "items": [ { "info": { "name": "Amazon Pinpoint Get Email Template", "type": "http" }, "http": { "method": "GET", "url": "http://pinpoint.{region}.amazonaws.com/v1/templates/:template-name/email", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "template-name", "value": "", "type": "path", "description": "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." }, { "name": "version", "value": "", "type": "query", "description": "

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

" } ] }, "docs": "Retrieves the content and settings of a message template for messages that are sent through the email channel." }, { "info": { "name": "Amazon Pinpoint Create Email Template", "type": "http" }, "http": { "method": "POST", "url": "http://pinpoint.{region}.amazonaws.com/v1/templates/:template-name/email", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "template-name", "value": "", "type": "path", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a message template for messages that are sent through the email channel." }, { "info": { "name": "Amazon Pinpoint Update Email Template", "type": "http" }, "http": { "method": "PUT", "url": "http://pinpoint.{region}.amazonaws.com/v1/templates/:template-name/email", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "create-new-version", "value": "", "type": "query", "description": "

Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.

If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.

" }, { "name": "template-name", "value": "", "type": "path", "description": "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." }, { "name": "version", "value": "", "type": "query", "description": "

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing message template for messages that are sent through the email channel." }, { "info": { "name": "Amazon Pinpoint Delete Email Template", "type": "http" }, "http": { "method": "DELETE", "url": "http://pinpoint.{region}.amazonaws.com/v1/templates/:template-name/email", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "template-name", "value": "", "type": "path", "description": "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." }, { "name": "version", "value": "", "type": "query", "description": "

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

" } ] }, "docs": "Deletes a message template for messages that were sent through the email channel." }, { "info": { "name": "Amazon Pinpoint Get in App Template", "type": "http" }, "http": { "method": "GET", "url": "http://pinpoint.{region}.amazonaws.com/v1/templates/:template-name/inapp", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "template-name", "value": "", "type": "path", "description": "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." }, { "name": "version", "value": "", "type": "query", "description": "

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

" } ] }, "docs": "Retrieves the content and settings of a message template for messages sent through the in-app channel." }, { "info": { "name": "Amazon Pinpoint Create in App Template", "type": "http" }, "http": { "method": "POST", "url": "http://pinpoint.{region}.amazonaws.com/v1/templates/:template-name/inapp", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "template-name", "value": "", "type": "path", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new message template for messages using the in-app message channel." }, { "info": { "name": "Amazon Pinpoint Update in App Template", "type": "http" }, "http": { "method": "PUT", "url": "http://pinpoint.{region}.amazonaws.com/v1/templates/:template-name/inapp", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "create-new-version", "value": "", "type": "query", "description": "

Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.

If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.

" }, { "name": "template-name", "value": "", "type": "path", "description": "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." }, { "name": "version", "value": "", "type": "query", "description": "

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing message template for messages sent through the in-app message channel." }, { "info": { "name": "Amazon Pinpoint Delete in App Template", "type": "http" }, "http": { "method": "DELETE", "url": "http://pinpoint.{region}.amazonaws.com/v1/templates/:template-name/inapp", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "template-name", "value": "", "type": "path", "description": "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." }, { "name": "version", "value": "", "type": "query", "description": "

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

" } ] }, "docs": "Deletes a message template for messages sent using the in-app message channel." }, { "info": { "name": "Amazon Pinpoint Get Push Template", "type": "http" }, "http": { "method": "GET", "url": "http://pinpoint.{region}.amazonaws.com/v1/templates/:template-name/push", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "template-name", "value": "", "type": "path", "description": "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." }, { "name": "version", "value": "", "type": "query", "description": "

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

" } ] }, "docs": "Retrieves the content and settings of a message template for messages that are sent through a push notification channel." }, { "info": { "name": "Amazon Pinpoint Create Push Template", "type": "http" }, "http": { "method": "POST", "url": "http://pinpoint.{region}.amazonaws.com/v1/templates/:template-name/push", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "template-name", "value": "", "type": "path", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a message template for messages that are sent through a push notification channel." }, { "info": { "name": "Amazon Pinpoint Update Push Template", "type": "http" }, "http": { "method": "PUT", "url": "http://pinpoint.{region}.amazonaws.com/v1/templates/:template-name/push", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "create-new-version", "value": "", "type": "query", "description": "

Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.

If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.

" }, { "name": "template-name", "value": "", "type": "path", "description": "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." }, { "name": "version", "value": "", "type": "query", "description": "

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing message template for messages that are sent through a push notification channel." }, { "info": { "name": "Amazon Pinpoint Delete Push Template", "type": "http" }, "http": { "method": "DELETE", "url": "http://pinpoint.{region}.amazonaws.com/v1/templates/:template-name/push", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "template-name", "value": "", "type": "path", "description": "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." }, { "name": "version", "value": "", "type": "query", "description": "

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

" } ] }, "docs": "Deletes a message template for messages that were sent through a push notification channel." }, { "info": { "name": "Amazon Pinpoint Get Sms Template", "type": "http" }, "http": { "method": "GET", "url": "http://pinpoint.{region}.amazonaws.com/v1/templates/:template-name/sms", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "template-name", "value": "", "type": "path", "description": "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." }, { "name": "version", "value": "", "type": "query", "description": "

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

" } ] }, "docs": "Retrieves the content and settings of a message template for messages that are sent through the SMS channel." }, { "info": { "name": "Amazon Pinpoint Create Sms Template", "type": "http" }, "http": { "method": "POST", "url": "http://pinpoint.{region}.amazonaws.com/v1/templates/:template-name/sms", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "template-name", "value": "", "type": "path", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a message template for messages that are sent through the SMS channel." }, { "info": { "name": "Amazon Pinpoint Update Sms Template", "type": "http" }, "http": { "method": "PUT", "url": "http://pinpoint.{region}.amazonaws.com/v1/templates/:template-name/sms", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "create-new-version", "value": "", "type": "query", "description": "

Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.

If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.

" }, { "name": "template-name", "value": "", "type": "path", "description": "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." }, { "name": "version", "value": "", "type": "query", "description": "

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing message template for messages that are sent through the SMS channel." }, { "info": { "name": "Amazon Pinpoint Delete Sms Template", "type": "http" }, "http": { "method": "DELETE", "url": "http://pinpoint.{region}.amazonaws.com/v1/templates/:template-name/sms", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "template-name", "value": "", "type": "path", "description": "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." }, { "name": "version", "value": "", "type": "query", "description": "

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

" } ] }, "docs": "Deletes a message template for messages that were sent through the SMS channel." }, { "info": { "name": "Amazon Pinpoint Get Voice Template", "type": "http" }, "http": { "method": "GET", "url": "http://pinpoint.{region}.amazonaws.com/v1/templates/:template-name/voice", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "template-name", "value": "", "type": "path", "description": "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." }, { "name": "version", "value": "", "type": "query", "description": "

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

" } ] }, "docs": "Retrieves the content and settings of a message template for messages that are sent through the voice channel." }, { "info": { "name": "Amazon Pinpoint Create Voice Template", "type": "http" }, "http": { "method": "POST", "url": "http://pinpoint.{region}.amazonaws.com/v1/templates/:template-name/voice", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "template-name", "value": "", "type": "path", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a message template for messages that are sent through the voice channel." }, { "info": { "name": "Amazon Pinpoint Update Voice Template", "type": "http" }, "http": { "method": "PUT", "url": "http://pinpoint.{region}.amazonaws.com/v1/templates/:template-name/voice", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "create-new-version", "value": "", "type": "query", "description": "

Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.

If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.

" }, { "name": "template-name", "value": "", "type": "path", "description": "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." }, { "name": "version", "value": "", "type": "query", "description": "

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing message template for messages that are sent through the voice channel." }, { "info": { "name": "Amazon Pinpoint Delete Voice Template", "type": "http" }, "http": { "method": "DELETE", "url": "http://pinpoint.{region}.amazonaws.com/v1/templates/:template-name/voice", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "template-name", "value": "", "type": "path", "description": "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." }, { "name": "version", "value": "", "type": "query", "description": "

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

" } ] }, "docs": "Deletes a message template for messages that were sent through the voice channel." }, { "info": { "name": "Amazon Pinpoint List Template Versions", "type": "http" }, "http": { "method": "GET", "url": "http://pinpoint.{region}.amazonaws.com/v1/templates/:template-name/:template-type/versions", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "next-token", "value": "", "type": "query", "description": "The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics." }, { "name": "page-size", "value": "", "type": "query", "description": "The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics." }, { "name": "template-name", "value": "", "type": "path", "description": "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." }, { "name": "template-type", "value": "", "type": "path", "description": "The type of channel that the message template is designed for. Valid values are: EMAIL, PUSH, SMS, and VOICE." } ] }, "docs": "Retrieves information about all the versions of a specific message template." }, { "info": { "name": "Amazon Pinpoint List Templates", "type": "http" }, "http": { "method": "GET", "url": "http://pinpoint.{region}.amazonaws.com/v1/templates", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "next-token", "value": "", "type": "query", "description": "The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics." }, { "name": "page-size", "value": "", "type": "query", "description": "The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics." }, { "name": "prefix", "value": "", "type": "query", "description": "The substring to match in the names of the message templates to include in the results. If you specify this value, Amazon Pinpoint returns only those templates whose names begin with the value that you specify." }, { "name": "template-type", "value": "", "type": "query", "description": "The type of message template to include in the results. Valid values are: EMAIL, PUSH, SMS, and VOICE. To include all types of templates in the results, don't include this parameter in your request." } ] }, "docs": "Retrieves information about all the message templates that are associated with your Amazon Pinpoint account." }, { "info": { "name": "Amazon Pinpoint Update Template Active Version", "type": "http" }, "http": { "method": "PUT", "url": "http://pinpoint.{region}.amazonaws.com/v1/templates/:template-name/:template-type/active-version", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "template-name", "value": "", "type": "path", "description": "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." }, { "name": "template-type", "value": "", "type": "path", "description": "The type of channel that the message template is designed for. Valid values are: EMAIL, PUSH, SMS, and VOICE." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Changes the status of a specific version of a message template to active." } ] } ], "bundled": true }