Skip to contentDevelopersPrezly website
Sender addresses

Create Sender Address

Create an email sender identity for the integration’s account and user.

Personal tokens are not supported for this endpoint. Use an integration API key. Your account must also have access to the requested data. Authentication

The first sender becomes default even when is_default is false. Creation can provision sending-domain configuration; inspect approval and domain readiness before using it.

Read the guide

POST
/sender-addresses
  • It's not allowed to have multiple exactly the same senders (sender_name + sender_email combo). An error will be thrown (409 Conflict).

The first sender address for this user in the account becomes the default even when is_default is false. Setting is_default true selects it; false does not clear an existing default. Creating a custom sender can trigger domain provisioning. Approval and domain configuration still determine sending readiness.

Personal access tokens are not supported for this endpoint. Use an integration API key with the required permissions.

Authorization

API_key
headerAuthorizationBearer <token>

Bearer authentication using an integration API key, or a personal access token only where the operation explicitly supports it. Every listed personal-token scope is required; owner permissions and newsroom access still apply.

Request Body

application/json
  1. body
sender_email*string
Formatemail
sender_name*string
is_default?boolean

Response Body

Created

application/json
  1. response
sender?

Email sender address (and name) that can be used to send emails from within Prezly.

Example Request
curl -X POST 'https://api.prezly.com/v2/sender-addresses' \  -H 'Content-Type: application/json' \  -d '{  "sender_email": "user@example.com",  "sender_name": "string"}'
Example Response
{  "sender": {    "id": 0,    "sender_email": "user@example.com",    "sender_name": "string",    "type": "string",    "is_default": true,    "is_public_webmail": true,    "domain": {      "domain_name": "example.com",      "is_valid": true,      "is_public_webmail": true,      "is_prezlymail": true,      "is_upgrade_recommended": true,      "verification_flow_version": "v1"    },    "is_verified": true,    "is_approved": true,    "domain_info": "string"  }}