Lists

Update a subscriber list

Partial update. Omitted fields are left alone, and null for description, confirmation_template_id or redirect_url is treated the same as omitting them — this surface cannot clear a field back to empty yet.

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.

Turning double_opt_in on affects only memberships created afterwards. Existing CONFIRMED memberships stay confirmed: those contacts consented under the rule in force when they subscribed, and demoting them would revoke a consent record rather than collect one.

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

patch/api/v1/lists/{id}

Request

  • Base URL: https://api.sendly.now
  • URL: https://api.sendly.now/api/v1/lists/{id}
  • 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)

Path parameters

idstring uuid required

Resource id.

Request body

confirmation_template_idstring uuid nullable
descriptionstring nullable
double_opt_inboolean
namestring
redirect_urlstring uri nullable

Response

The updated 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.