Skip to main content
POST
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Headers

Idempotency-Key
string

Makes this write safe to retry: a repeat with the same key replays the first response instead of creating a second resource. Scoped to the account, remembered for 24 hours; reusing a key with a different payload is an error.

Maximum string length: 255

Body

application/json
email
string<email>
required

The sender's email address, e.g. partner@example.org.

Maximum string length: 254

Response

Already allowed

object
string
required
id
string
required
email
string
required
created_at
string<date-time>
required