Skip to main content
POST
Update contact list subscription status

Authorizations

Authorization
string
header
required

API token for authentication

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
enum<string>
required

New subscription status

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

"active"

Response

Status updated successfully

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