Sign in

v14

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-279719892.3 MB
Status

Update a contact's subscription status

Set the subscription status of a specific contact.

post/communication-preferences/2026-03/statuses/{subscriberIdString}

Path parameters

subscriberIdStringstring required

The unique identifier of the subscriber whose communication preferences status is being updated.

Request body

channel'EMAIL' required

The type of communication channel, with 'EMAIL' as the only supported option.

legalBasis'CONSENT_WITH_NOTICE' | 'LEGITIMATE_INTEREST_CLIENT' | 'LEGITIMATE_INTEREST_OTHER' | 'LEGITIMATE_INTEREST_PQL' | 'NON_GDPR' | 'PERFORMANCE_OF_CONTRACT' | 'PROCESS_AND_STORE'

The legal basis for communication, with options including 'LEGITIMATE_INTEREST_PQL', 'LEGITIMATE_INTEREST_CLIENT', 'PERFORMANCE_OF_CONTRACT', 'CONSENT_WITH_NOTICE', 'NON_GDPR', 'PROCESS_AND_STORE', and 'LEGITIMATE_INTEREST_OTHER'.

legalBasisExplanationstring

An explanation for the legal basis used for communication.

statusState'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED' required

The current subscription status of the contact, which can be 'SUBSCRIBED', 'UNSUBSCRIBED', or 'NOT_SPECIFIED'.

subscriptionIdinteger required

The unique identifier of the subscription to be updated.

Response

successful operation

completedAtstring date-time required

The date and time when the operation was completed.

linksobject

Contains URLs related to the response, such as documentation or resources.

numErrorsinteger

The number of errors that occurred during the operation.

requestedAtstring date-time

The date and time when the request was made.

startedAtstring date-time required

The date and time when the operation started.

status'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING' required

Indicates the current status of the operation, with possible values: PENDING, PROCESSING, CANCELED, COMPLETE.