v24

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-014382230.2 KB

Update contact list subscription status

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).

post/api/contactLists.updateStatus

Request body

workspace_idstring required

The ID of the workspace

emailstring email required

Email address of the contact

list_idstring required

ID of the list

status'active' | 'pending' | 'unsubscribed' | 'bounced' | 'complained' required

New subscription status

Example request

{
  "workspace_id": "ws_1234567890",
  "email": "user@example.com",
  "list_id": "newsletter",
  "status": "active"
}

Response

Status updated successfully

successboolean

Whether the operation was successful

messagestring

Status message

foundboolean

Whether the contact was found in the list

Example response

{
  "success": true,
  "message": "status updated successfully",
  "found": true
}