Skip to main content
POST
email.sender.set

Authorizations

Authorization
string
header
required

A Lath API key: lath_live_sk… or lath_test_sk… on a server, lath_live_pk… or lath_test_pk… in a browser.

Headers

Idempotency-Key
string

Replays the stored response for the same key and input; refuses different input.

Body

application/json
local
string

The part before the @, like "hello" or "team". Letters, digits, dot, hyphen and underscore.

Required string length: 1 - 64
label
string

The subdomain label under the sending parent. Must be unused by any other project.

Required string length: 1 - 63
name
string | null

The display name beside the address. Pass null to follow the project name.

Required string length: 1 - 100

Response

{ activityId, result }. activityId is empty for reads.

activityId
string
required

The activity this call created, or empty for a read.

result
object
required
Last modified on September 13, 2026