Lists

Create a subscriber list

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.

post/api/v1/lists

Request

  • Base URL: https://api.sendly.now
  • URL: https://api.sendly.now/api/v1/lists
  • Auth: one of:
    • HTTP bearer
    • API key in cookie better-auth.session_token
    • OAuth 2 (authorization code, authorization URL https://app.sendly.now/api/auth/oauth2/authorize, token URL https://app.sendly.now/api/auth/oauth2/token, scopes: lists:write)

Request body

confirmation_template_idstring uuid nullable
descriptionstring nullable
double_opt_inboolean

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.

namestring required
redirect_urlstring uri nullable

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

Response

The created list

confirmation_template_idstring uuid nullable required
created_atstring date-time required
descriptionstring nullable required
double_opt_inboolean required
idstring uuid required
member_countinteger required

Memberships in ANY status, including PENDING and UNSUBSCRIBED ones.

namestring required
redirect_urlstring nullable required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.