Menu
Amazon Pinpoint
REST API Reference

Email Channel

A channel defines the types of platforms to which you can deliver messages. To send an email, you send the message through the email channel type. You can use this resource to create or update an email channel.

URI

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

HTTP Methods

DELETE

Delete an email channel

Header

Name Required Type

accept

false

string

Path

Name Required Type

application-id

true

string

Response

Status Code Schema

200

EmailChannelResponse

GET

Get an email channel

Header

Name Required Type

accept

false

string

Path

Name Required Type

application-id

true

string

Response

Status Code Schema

200

EmailChannelResponse

PUT

Update an email channel

Body

Name Required Type

EmailChannelRequest

true

EmailChannelRequest

Header

Name Required Type

accept

false

string

Path

Name Required Type

application-id

true

string

Response

Status Code Schema

200

EmailChannelResponse

Errors

Errors

Status Code Schema Error Type

400

MessageBody

BadRequestException

403

MessageBody

ForbiddenException

404

MessageBody

NotFoundException

405

MessageBody

MethodNotAllowedException

429

MessageBody

TooManyRequestsException

500

MessageBody

InternalServerErrorException

Schemas

Request Schemas

Example EmailChannelRequest

Copy
{ "Enabled": true, "Identity": "string", "FromAddress": "string", "RoleArn": "string" }

Response Schemas

Example EmailChannelResponse

Copy
{ "ApplicationId": "string", "IsArchived": true, "Version": 0, "CreationDate": "string", "LastModifiedDate": "string", "LastModifiedBy": "string", "Id": "string", "Enabled": true, "Identity": "string", "FromAddress": "string", "RoleArn": "string", "Platform": "string" }

Example MessageBody

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

Attributes

EmailChannelRequest

Attribute Type Description

Enabled

boolean

If the channel is enabled for sending messages.

FromAddress

string

The email address used to send emails from.

Identity

string

The ARN of an identity verified with SES.

RoleArn

string

The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service

EmailChannelResponse

Attribute Type Description

ApplicationId

string

The unique ID of the application to which the email channel belongs.

CreationDate

string

The date that the settings were last updated in ISO 8601 format.

Enabled

boolean

If the channel is enabled for sending messages.

FromAddress

string

The email address used to send emails from.

Id

string

Channel ID. Not used, only for backwards compatibility.

Identity

string

The ARN of an identity verified with SES.

IsArchived

boolean

Is this channel archived

LastModifiedBy

string

Who last updated this entry

LastModifiedDate

string

Last date this was updated

Platform

string

Platform type. Will be "EMAIL"

RoleArn

string

The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service

Version

integer

Version of channel

MessageBody

Attribute Type Description

Message

string

The error message returned from the API.

RequestID

string

The unique message body ID.