Manage email senders

A sender identity combines an email address and display name for campaigns and pitches. It is associated with the integration's account and user. Creating an identity does not send a campaign or establish that its domain is ready for delivery.

All sender-address endpoints require an integration API key; personal tokens are unsupported. Arrange the key and account access, then load it into PREZLY_API_TOKEN. Creation additionally requires permission to create sender addresses. Keep these requests on your server.

Inspect identities and domain readinessCopy Anchor Link

curl --fail-with-body --silent --show-error 'https://api.prezly.com/v2/sender-addresses' \
  --header "Authorization: Bearer $PREZLY_API_TOKEN" \
  --header 'Accept: application/json'

The response contains an unpaginated senders array ordered by email and name. Select the intended identity rather than the first result; retain its numeric id. Read one before changing it:

curl --fail-with-body --silent --show-error 'https://api.prezly.com/v2/sender-addresses/YOUR_SENDER_ID' \
  --header "Authorization: Bearer $PREZLY_API_TOKEN" \
  --header 'Accept: application/json'

The detail envelope is sender. Inspect sender_email, sender_name, is_default, is_approved, and domain.is_valid. is_verified is currently always true in this serializer and is not evidence of approval or DNS readiness.

Complete sending-domain setup in Prezly before relying on a custom identity. Public webmail domains cannot be verified as your own sending domain. Website custom-domain setup is a separate configuration; a working newsroom hostname does not authenticate an email sender.

List senders → · Get sender →

Create a custom identityCopy Anchor Link

Use an address you control. The example is deliberately illustrative; replace it and the display name:

curl --fail-with-body --silent --show-error --request POST 'https://api.prezly.com/v2/sender-addresses' \
  --header "Authorization: Bearer $PREZLY_API_TOKEN" \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --data '{"sender_email":"press@example.test","sender_name":"Acme Press Team","is_default":false}'

The response is 201 Created with sender. The first identity for that account/user becomes default even if you supplied is_default: false. Creation can provision sending-domain configuration; inspect the resulting approval/domain state rather than assuming the 201 response authorizes sending.

An identical name/address pair conflicts with 409; the same email can have a different display name. Creation is not an upsert. After an uncertain response, list the actor's identities and reconcile the exact pair before retrying. Prezlymail addresses are managed by Prezly and cannot be manually created with this operation.

Create sender →

Rename or choose a defaultCopy Anchor Link

curl --fail-with-body --silent --show-error --request PATCH 'https://api.prezly.com/v2/sender-addresses/YOUR_SENDER_ID' \
  --header "Authorization: Bearer $PREZLY_API_TOKEN" \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --data '{"sender_name":"Acme Media Team","is_default":true}'

The response is 200 OK with sender. The email address is immutable: create a replacement identity if it changes. Omitted values are retained for a non-empty partial update.

Setting is_default: true clears the default on the other identities for this account/user. Sending false does not clear an existing default; choose a different identity with true instead. Re-read the list after switching and keep explicit sender IDs in campaign/pitch requests rather than assuming a default change rewrites existing drafts.

Update sender →

Remove an unused custom identityCopy Anchor Link

Check drafts and integrations that reference the ID, and choose a replacement default first if needed:

curl --fail-with-body --silent --show-error --request DELETE 'https://api.prezly.com/v2/sender-addresses/YOUR_SENDER_ID' \
  --header "Authorization: Bearer $PREZLY_API_TOKEN" \
  --header 'Accept: application/json'

Success returns 204 No Content. Default and Prezlymail identities cannot be deleted; the API returns 405 for those restrictions. Treat that response as a protected identity, not a transient error to retry. Removing an identity does not remove the mailbox or retract sent email. See Handling errors for other failures.

Delete sender →