Lists

Update contact list subscription status

POST https://demo.notifuse.com/api/contactLists.updateStatus

Updates the subscription status of a contact in a specific list. Can set status to active, pending, unsubscribed, bounced, or complained.

Note: This endpoint only modifies existing list memberships. It does not add a contact to a list. To add a contact to a list, use the /subscribe endpoint (for public lists) or the /api/contacts.import endpoint (for any list, requires authentication).

Authorizations

Authorization string header required

Bearer authentication header of the form Bearer <token>, where <token> is your API key.

Body application/json

workspace_id string required

The ID of the workspace

  • Example: ws_1234567890
email string<email> required

Email address of the contact

  • Example: user@example.com
list_id string required

ID of the list

  • Example: newsletter
status string required

New subscription status

  • Available options: active, pending, unsubscribed, bounced, complained
  • Example: active

Response

200 Status updated successfully object
success boolean

Whether the operation was successful

  • Example: true
message string

Status message

  • Example: status updated successfully
found boolean

Whether the contact was found in the list

  • Example: true
400 Bad request - validation failed object
error string required

Error message

401 Unauthorized - invalid or missing authentication token object
error string required

Error message

404 Contact list relationship not found object
error string required

Error message

500 Internal server error object
error string required

Error message