Skip to contentDevelopersPrezly website
Sender addresses

Update a Sender Address

Rename a sender identity or select it as the default.

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

Returns sender. sender_email is immutable; is_default: false does not clear the current default. Select a different sender with true instead.

Read the guide

PATCH
/sender-addresses/{id}
  • It's only allowed to update sender name, or set it to default.
  • It's not allowed to have multiple exactly the same senders (sender_name + sender_email combo). An error will be thrown (409 Conflict).
  • Sender email cannot be updated.

sender_email is immutable; changing it is rejected with 422. Set is_default:true to select this sender. False does not clear a default. is_verified is currently hard-coded true and does not establish sending readiness; inspect approval and domain state.

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.

Path Parameters

id*number

Sender Address ID

Request Body

application/json
  1. body
sender_name?string
is_default?boolean

Response Body

OK

application/json
  1. response
sender*

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

Example Request
curl -X PATCH 'https://api.prezly.com/v2/sender-addresses/0' \  -H 'Content-Type: application/json' \  -d '{}'
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"  }}