Amazon Pinpoint Email Service
API Reference (API Version 2018-07-26)

CreateConfigurationSet

Create a configuration set. Configuration sets are groups of rules that you can apply to the emails you send using Amazon Pinpoint. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

Request Syntax

POST /v1/email/configuration-sets HTTP/1.1 Content-type: application/json { "ConfigurationSetName": "string", "DeliveryOptions": { "SendingPoolName": "string" }, "ReputationOptions": { "LastFreshStart": number, "ReputationMetricsEnabled": boolean }, "SendingOptions": { "SendingEnabled": boolean }, "TrackingOptions": { "CustomRedirectDomain": "string" } }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ConfigurationSetName

The name of the configuration set.

Type: String

Required: No

DeliveryOptions

An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.

Type: DeliveryOptions object

Required: No

ReputationOptions

An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails that you send that use the configuration set.

Type: ReputationOptions object

Required: No

SendingOptions

An object that defines whether or not Amazon Pinpoint can send email that you send using the configuration set.

Type: SendingOptions object

Required: No

TrackingOptions

An object that defines the open and click tracking options for emails that you send using the configuration set.

Type: TrackingOptions object

Required: No

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

AlreadyExistsException

The resource specified in your request already exists.

HTTP Status Code: 400

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

LimitExceededException

There are too many instances of the specified resource type.

HTTP Status Code: 400

NotFoundException

The resource you attempted to access doesn't exist.

HTTP Status Code: 404

TooManyRequestsException

Too many requests have been made to the operation.

HTTP Status Code: 429

See Also

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