Senders: Create
Creates an email sender for an Entity or the account.
Provide email.emailAddress. To associate the sender with a Knowledge Graph Entity, set email.entityId to its exact Entity ID. Omit that field for an account-level sender. You can also provide a reply-to address and display name.
The default verificationMode is SENDER_VERIFICATION_MODE_REQUIRED. Complete the verification email flow when the response status is pending. SENDER_VERIFICATION_MODE_SKIP requires an active, provider-verified domain and is unavailable for sandbox accounts. Both modes validate the sender's ownership and uniqueness.
A verified sender must still meet domain and sending requirements when used by a campaign. This method creates a sender; it does not update an existing sender or provide a request ID for duplicate detection.
Authorizations:
path Parameters
| account required | string External account ID, or |
query Parameters
| v required | string^[0-9]{8}$ Default: "20240401" API version date in YYYYMMDD format. Use one fixed date for your integration; supply this parameter once per request. |
Request Body schema: application/json
mailPublicEmailSender (object) or (object or null) | |
mailSenderVerificationMode (string) or (object or null) |
Responses
Request samples
- Payload
{- "email": {
- "emailAddress": "advisor@mail.example.com",
- "entityId": "branch-nyc-001",
- "replyTo": {
- "emailAddress": "service@example.com",
- "displayName": "New York Service Desk"
}
}, - "verificationMode": "SENDER_VERIFICATION_MODE_REQUIRED"
}Response samples
- 200
- default
{- "meta": {
- "uuid": "7b4b7f0f-17cf-4bec-81b0-97a729f25e54",
- "errors": [ ]
}, - "response": {
- "name": "accounts/514581/senders/019a1234-5678-7000-8000-000000000003",
- "channel": "SENDER_CHANNEL_EMAIL",
- "email": {
- "emailAddress": "advisor@mail.example.com",
- "entityId": "branch-nyc-001",
- "replyTo": {
- "emailAddress": "service@example.com",
- "displayName": "New York Service Desk"
}
}, - "verificationStatus": "SENDER_IDENTITY_STATUS_PENDING",
- "verifiedAt": null
}
}