Amazon Pinpoint
REST API Reference

Email Channel

A channel is a type of platform that you can deliver messages to. You can use the email channel to send email to users. Before you can use Amazon Pinpoint to send email, you must enable the email channel for an Amazon Pinpoint application.

The Email Channel resource represents the status, identity, and other settings of the email channel for a specific application. You can use this resource to retrieve information about, update, or disable (delete) the email channel for an application.

URI

/v1/apps/application-id/channels/email

HTTP Methods

GET

Operation ID: GetEmailChannel

Retrieves information about the status and settings of the email channel for an application.

Path Parameters

Name Type Required Description
application-id String True

The unique identifier for the application.

Header Parameters

Name Type Required Description
accept String False

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

x-amz-user-agent String False

Identifies the client that's sending the request.

Responses

Status Code Response Model Description
200 EmailChannelResponse

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).

PUT

Operation ID: UpdateEmailChannel

Updates the status and settings of the email channel for an application.

Path Parameters

Name Type Required Description
application-id String True

The unique identifier for the application.

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 EmailChannelResponse

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).

DELETE

Operation ID: DeleteEmailChannel

Disables the email channel for an application and deletes any existing settings for the channel.

Path Parameters

Name Type Required Description
application-id String True

The unique identifier for the application.

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 EmailChannelResponse

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).

OPTIONS

Retrieves information about the communication requirements and options that are available for the Email Channel resource.

Responses

Status Code Response Model Description
200 None

The request succeeded.

Schemas

Request Bodies

Example PUT

{ "Enabled": boolean, "Identity": "string", "FromAddress": "string", "RoleArn": "string", "ConfigurationSet": "string" }

Response Bodies

Example EmailChannelResponse

{ "ApplicationId": "string", "IsArchived": boolean, "Version": integer, "CreationDate": "string", "LastModifiedDate": "string", "LastModifiedBy": "string", "Id": "string", "Enabled": boolean, "Identity": "string", "FromAddress": "string", "RoleArn": "string", "ConfigurationSet": "string", "Platform": "string", "MessagesPerSecond": integer, "HasCredential": boolean }

Example MessageBody

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

Properties

EmailChannelRequest

Property Type Required Description
Enabled

boolean

True

Specifies whether to enable the email channel for the application.

Identity

string

True

The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you want to use when you send email through the channel.

FromAddress

string

True

The verified email address that you want to send email from when you send email through the channel.

RoleArn

string

False

The ARN of the AWS Identity and Access Management (IAM) role that you want Amazon Pinpoint to use when it submits email-related event data for the channel.

ConfigurationSet

string

False

The configuration set that you want to apply to email that you send through the channel by using the Amazon Pinpoint Email API.

EmailChannelResponse

Property Type Required Description
ApplicationId

string

False

The unique identifier for the application that the email channel applies to.

IsArchived

boolean

False

Specifies whether the email channel is archived.

Version

integer

False

The current version of the email channel.

CreationDate

string

False

The date and time, in ISO 8601 format, when the email channel was created.

LastModifiedDate

string

False

The date and time, in ISO 8601 format, when the email channel was last modified.

LastModifiedBy

string

False

The user who last modified the email channel.

Id

string

False

(Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.

Enabled

boolean

False

Specifies whether the email channel is enabled for the application.

Identity

string

False

The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you use when you send email through the channel.

FromAddress

string

False

The verified email address that you send email from when you send email through the channel.

RoleArn

string

False

The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.

ConfigurationSet

string

True

The configuration set that's applied to email that's sent through the channel by using the Amazon Pinpoint Email API.

Platform

string

True

The type of messaging or notification platform for the channel. For the email channel, this value is EMAIL.

MessagesPerSecond

integer

False

The maximum number of emails that you can send through the channel each second.

HasCredential

boolean

False

(Not used) This property is retained only for backward compatibility.

MessageBody

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.

See Also

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

GetEmailChannel

UpdateEmailChannel

DeleteEmailChannel