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.
AuthorizationBearer <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.
id*stringResource id.
uuidapplication/json- body
Body for PATCH /api/v1/lists/{id}.
name?string1 <= length <= 200description?|length <= 500double_opt_in?booleanconfirmation_template_id?|uuidredirect_url?|uriThe updated list
application/json- response
A subscriber list as exposed on the v1 API.
id*stringuuidname*stringdescription*string|nulldouble_opt_in*booleanconfirmation_template_id*|uuidredirect_url*string|nullmember_count*integerMemberships in ANY status, including PENDING and UNSUBSCRIBED ones.
created_at*stringdate-timeupdated_at*stringdate-timecurl -X PATCH 'https://api.sendly.now/api/v1/lists/497f6eca-6276-4993-bfeb-53cbbbba6f08' \ -H 'Content-Type: application/json' \ -d '{}'{ "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"}