Skip to content
Qrona Newsletter
Sign inCreate an account

Reference / Lists

Update list

PATCH/api/v1/lists/{id}

Name, description and sign-up mode.

Scope

  • lists:write Edit lists – the person behind the key must be editor or higher.

Path parameters

idstringrequired
The list's ID.

Body

JSON, Content-Type: application/json. Unknown fields return 422.

namestring
at least 1 characters · at most 200 characters
descriptionstring | null
at most 1000 characters
double_opt_inboolean
New sign-ups must confirm by email. Default: true.

Response

200 The list after the change.

idstringrequired
namestringrequired
descriptionstring | nullrequired
double_opt_inbooleanrequired
New sign-ups must confirm by email before they are added.
form_enabledbooleanrequired
The list's public sign-up form is open.
countsobjectrequired
Only the contacts that the person behind the key may see.
counts.subscribedintegerrequired
Receive mailings: on the list, active and not suppressed.
counts.pendingintegerrequired
Has signed up but not confirmed yet.
counts.unsubscribedintegerrequired
counts.blockedintegerrequired
On the list but not reachable: they bounce, have made a spam complaint or are suppressed.
created_atstring (time, ISO 8601)required
When the list was created.

Errors

400
bad_request
401
unauthenticatedinvalid_keykey_revokedkey_expiredkey_inactive
402
payment_required
403
insufficient_scopeforbiddenworkspace_suspended
404
not_found
415
unsupported_media_type
422
validation_failed
429
rate_limited
500
internal_error