Skip to main content

Sender Identities

A sender identity is a verified from-address that a campaign can send from.

Overview

When you create or update a campaign, you choose which identity it sends from by setting from_identity to a sender identity's UUID. This endpoint group lets you list the identities available to your account so you can pick one.

Sender identities are configured in the dashboard. The API exposes them read-only — there is no endpoint to create or modify them.

Endpoints

MethodEndpointDescription
GET/sender-identitiesList sender identities

Sender Identity Object

FieldTypeDescription
uuidstringUnique identifier for the identity. Use it as a campaign's from_identity.
emailstringThe from-address mail is sent from.
from_namestring|nullDefault sender display name for this identity. null when not set.
reply_tostring|nullDefault reply-to address for this identity. null when not set.
statusstringactive, pending, or failed. See Sending readiness.
is_sendablebooleanWhether a campaign using this identity can be sent. true only when status is active.

Sending readiness

An identity has to be set up before mail can go out from it, and the list returns identities at every stage.

statusis_sendableMeaning
activetrueReady to send from.
pendingfalseStill being set up. It may become active on its own — no action needed.
failedfalseSetup did not complete. Fix the identity in the dashboard.

A campaign's from_identity accepts any identity, including one that is not sendable. The campaign is then held back rather than rejected: its readiness reports sender_enabled in missing, and sending or scheduling it returns 422 CAMPAIGN_NOT_READY until the identity becomes sendable. A test email returns 409 SENDER_NOT_SENDABLE.