Skip to Content
API ReferenceConfiguration SetsCreate configuration set

Create configuration set

POST /api/v1/partner/email/configuration-sets

Request body

{ "name": "production", "description": "Production transactional sends", "customer_id": "cust_550e8400-...", "sending_enabled": true, "reputation_tracking_enabled": true, "suppression_options": "BOUNCE_AND_COMPLAINT", "tags": { "env": "prod", "team": "platform" } }
FieldTypeRequiredNotes
namestringyesUnique per partner, alphanumeric + _ -, 1-256 chars
descriptionstringno
customer_iduuidnoDownstream end-customer attribution
sending_enabledboolnoDefault true
reputation_tracking_enabledboolnoDefault true
suppression_optionsstringnoNONE / BOUNCE / COMPLAINT / BOUNCE_AND_COMPLAINT (default)
custom_redirect_domainstringnoPer-config-set click-tracking host
tagsobjectnoArbitrary key-value pairs surfaced on mail.tags in webhooks

Response

{ "success": true, "configuration_set": { "config_set_id": "cs_550e8400-...", "name": "production", ... } }

Common errors

StatusCodeMeaning
409CONFIG_SET_NAME_TAKENAnother set with that name exists
400INVALID_REQUESTBad suppression_options value or missing name