Skip to main content
POST
/
subscribers
Create a new subscriber
curl --request POST \
  --url https://api.onset.io/v1/subscribers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "list_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'
{
  "id": "<string>",
  "email": "jsmith@example.com",
  "lists": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
email
string<email>
required

Subscriber email address

​
list_ids
string<uuid>[]

Array of list IDs to subscribe to

Response

Subscriber created successfully

​
id
string

Unique subscriber identifier

​
email
string<email>

Subscriber email address

​
lists
object[]

Lists the subscriber belongs to

​
created_at
string<date-time>

When the subscriber was created

​
updated_at
string<date-time>

When the subscriber was last updated