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.