---
title: "PUT /v1/apps/{application-id}/channels/email"
method: PUT
path: "/v1/apps/{application-id}/channels/email"
---

# PUT /v1/apps/{application-id}/channels/email

`PUT /v1/apps/{application-id}/channels/email`

Enables the email channel for an application or updates the status and settings of the email channel for an application.

## Path parameters

- `application-id` string, required

## Request body

- object
  - `EmailChannelRequest` object, required — Specifies the status and settings of the email channel for an application.
    - `ConfigurationSet` string — The <a href="https://docs.aws.amazon.com/ses/latest/APIReference/API_ConfigurationSet.html">Amazon SES configuration set</a> that you want to apply to messages that you send through the channel.
    - `Enabled` boolean — Specifies whether to enable the email channel for the application.
    - `FromAddress` string — <p>The verified email address that you want to send email from when you send email through the channel.</p>
    - `Identity` string — <p>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.</p>
    - `RoleArn` string — <p>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.</p>

## Response `200`

Success

- UpdateEmailChannelResponse
  - `EmailChannelResponse` EmailChannelResponse, required — Provides information about the status and settings of the email channel for an application.
    - `ApplicationId` string — The unique identifier for the application that the email channel applies to.
    - `ConfigurationSet` string — The <a href="https://docs.aws.amazon.com/ses/latest/APIReference/API_ConfigurationSet.html">Amazon SES configuration set</a> that's applied to messages that are sent through the channel.
    - `CreationDate` string — The date and time, in ISO 8601 format, when the email channel was enabled.
    - `Enabled` boolean — Specifies whether the email channel is enabled for the application.
    - `FromAddress` string — The verified email address that email is sent from when you send email through the channel.
    - `HasCredential` boolean — (Not used) This property is retained only for backward compatibility.
    - `Id` string — (Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.
    - `Identity` string — <p>The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that's used when you send email through the channel.</p>
    - `IsArchived` boolean — Specifies whether the email channel is archived.
    - `LastModifiedBy` string — The user who last modified the email channel.
    - `LastModifiedDate` string — The date and time, in ISO 8601 format, when the email channel was last modified.
    - `MessagesPerSecond` integer — The maximum number of emails that can be sent through the channel each second.
    - `Platform` string, required — The type of messaging or notification platform for the channel. For the email channel, this value is EMAIL.
    - `RoleArn` string — <p>The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.</p>
    - `Version` integer — The current version of the email channel.

## Other responses

- `480` — BadRequestException
- `481` — InternalServerErrorException
- `482` — PayloadTooLargeException
- `483` — ForbiddenException
- `484` — NotFoundException
- `485` — MethodNotAllowedException
- `486` — TooManyRequestsException

---

[API](https://skmtc.net/aws/apis/pinpoint.md) · [All operations](https://skmtc.net/aws/apis/pinpoint/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/pinpoint/versions/c0cf580f498b/schema)
