Sign in
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.

Changes

Changed in 6 of the 14 revisions of this API.11

  • b0d8bc008db92See the full diff
    • ○

      the security scope communication_preferences.read_write was added to the endpoint's security scheme private_apps

      api-security-scope-added

    • ○

      the security scope communication_preferences.write was removed from the endpoint's security scheme private_apps

      api-security-scope-removed

    This revision also has 77 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 3578967e48df2See the full diff
    • ○

      the security scope communication_preferences.read_write was added to the endpoint's security scheme private_apps

      api-security-scope-added

    • ○

      the security scope communication_preferences.write was removed from the endpoint's security scheme private_apps

      api-security-scope-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • e0403341222c2See the full diff
    • ○

      the security scope communication_preferences.read_write was added to the endpoint's security scheme private_apps

      api-security-scope-added

    • ○

      the security scope communication_preferences.write was removed from the endpoint's security scheme private_apps

      api-security-scope-removed

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f33be5a826102See the full diff
    • ○

      the security scope communication_preferences.read_write was added to the endpoint's security scheme private_apps

      api-security-scope-added

    • ○

      the security scope communication_preferences.write was removed from the endpoint's security scheme private_apps

      api-security-scope-removed

  • dc2fdad57f7f2See the full diff
    • ○

      the security scope communication_preferences.read_write was added to the endpoint's security scheme private_apps

      api-security-scope-added

    • ○

      the security scope communication_preferences.write was removed from the endpoint's security scheme private_apps

      api-security-scope-removed

    This revision also has 129 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 62586336cea21See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 73 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 14 revisions, 1 has no diff computed and 2 have a changelog that could not be searched.