Skip to main content
POST
Subscribe an address

Authorizations

Authorization
string
header
required

An API token. The "read" ability: GET routes only. "read + write": every route.

Headers

Idempotency-Key
string

Replay a write safely: the same key gives back the first answer for 24 hours (header Idempotent-Replay: true).

Maximum string length: 255

Path Parameters

list
string<uuid>
required

The list's identifier (uuid).

Body

application/json
email
string<email>
required
Maximum string length: 255
first_name
string | null
Maximum string length: 255
last_name
string | null
Maximum string length: 255
timezone
string | null

A valid IANA time zone.

locale
string | null

An ISO 639-1 code, with an optional region (fr, en, pt-BR).

attributes
object

Merged with the attributes already there.

tags
string[]

Added to the subscriber's own; an unknown tag is created.

Maximum string length: 255
skip_confirmation
boolean
default:false

Subscribes straight away, even with double opt-in. Only for consent you already hold.

Response

The subscriber, created or updated.

data
object