v1

latestOpenAPI 3.0.3“Commons Clause” License Condition v1.02026-07-17231343.3 KB

subscribers

Add a new subscriber

Add a new subscriber to the list.

post/subscribers

Request body

emailstring required

The subscriber's email address.

namestring

The subscriber's name.

segmentsinteger[]

Groups to place the subscriber in.

metadataobject

Metadata (key=value pairs) for the subscriber. These values can be used in the campaign templates to personalize the e-mail, used in a form of tags e.g. {{phone_number}}

Example request

{
  "email": "john@example.com",
  "name": "John Doe"
}

Response

idinteger

The ID of the resource.

created_atstring date-time

The date and time when the resource was created.

updated_atstring date-time

The date and time when the resource was last updated.

namestring

The name of the subscriber.

emailstring

The email of the subscriber.

metadataobject

Metadata associated with the subscriber.

blacklistedboolean

Flag that indicates if the subscriber has been blacklisted (unsubscribed, marked email as spam, bounced).

activeboolean

Flag that indicates if the subscriber is active or not (we send e-mails only to active subscribers).

Example response

{
  "id": 111,
  "name": "John Doe",
  "email": "john@example.com",
  "segments": [
    {
      "id": 111,
      "name": "Foo Group",
      "subscribers_in_segment": 123
    }
  ]
}