Skip to Content
SendlySendly
API ReferenceLists

Create a subscriber list

POST
/api/v1/lists

Create an empty subscriber list. member_count on the response is 0 because the list has just been created — add contacts with POST /api/lists/{id}/subscribe.

double_opt_in does not make Sendly send anything. With it on, POST /api/lists/{id}/subscribe creates the membership as PENDING and returns a confirm_token; delivering /api/lists/confirm-subscription?token=<token> to the contact is YOUR job. A list that turns the flag on without sending that link collects pending memberships and confirms none of them.

description, confirmation_template_id and redirect_url accept null, which means the same as omitting them: the field is left unset.

Requires the lists:write scope — Create, rename, and delete your subscriber lists.

headerAuthorizationBearer <API Key>

API key authentication. Use a sk_* (FULL) or pk_* (SENDING_ONLY) key as the bearer token. Public keys (pk_*) are restricted to the email-send endpoints and the self-serve list subscribe/unsubscribe pair; every other endpoint — event tracking included — answers 403 for them. In scope terms (used by /api/v1/* operations): FULL keys hold every scope; SENDING_ONLY keys hold only emails:send.

application/json
  1. body

Body for POST /api/v1/lists.

name*string
Length1 <= length <= 200
description?|
Lengthlength <= 500
double_opt_in?boolean

Require the contact to confirm before the membership becomes CONFIRMED. Sendly does NOT send the confirmation email — subscribing returns a confirm_token and you deliver /api/lists/confirm-subscription?token=<token> to the contact yourself.

Defaultfalse
confirmation_template_id?|
Formatuuid
redirect_url?|

Where a confirmed contact is sent after following the confirmation link.

Formaturi

Response Body

The created list

application/json
  1. response

A subscriber list as exposed on the v1 API.

id*string
Formatuuid
name*string
description*string|null
double_opt_in*boolean
confirmation_template_id*|
Formatuuid
redirect_url*string|null
member_count*integer

Memberships in ANY status, including PENDING and UNSUBSCRIBED ones.

created_at*string
Formatdate-time
updated_at*string
Formatdate-time
Example Request
curl -X POST 'https://api.sendly.now/api/v1/lists' \  -H 'Content-Type: application/json' \  -d '{  "name": "string"}'
Example Response
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "description": "string",  "double_opt_in": true,  "confirmation_template_id": "17dc8a7d-cf14-4d56-b0d2-d285cf33f3bb",  "redirect_url": "string",  "member_count": 0,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}