Saltar al contenido principal
POST
/
communication-preferences
/
v4
/
statuses
/
{subscriberIdString}
Actualizar el estado de suscripción de un contacto
curl --request POST \
  --url https://api.hubapi.com/communication-preferences/v4/statuses/{subscriberIdString} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "channel": "EMAIL",
  "statusState": "NOT_SPECIFIED",
  "subscriptionId": 123,
  "legalBasis": "CONSENT_WITH_NOTICE",
  "legalBasisExplanation": "<string>"
}
'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "channel": "EMAIL",
      "source": "<string>",
      "status": "NOT_SPECIFIED",
      "subscriberIdString": "<string>",
      "subscriptionId": 123,
      "timestamp": "2023-11-07T05:31:56Z",
      "businessUnitId": 123,
      "legalBasis": "CONSENT_WITH_NOTICE",
      "legalBasisExplanation": "<string>",
      "setStatusSuccessReason": "NO_STATUS_CHANGE",
      "subscriptionName": "<string>"
    }
  ],
  "startedAt": "2023-11-07T05:31:56Z",
  "status": "CANCELED",
  "errors": [
    {
      "category": "<string>",
      "context": {},
      "errors": [
        {
          "message": "<string>",
          "code": "<string>",
          "context": "{missingScopes=[scope1, scope2]}",
          "in": "<string>",
          "subCategory": "<string>"
        }
      ],
      "links": {},
      "message": "<string>",
      "status": "<string>",
      "id": "<string>",
      "subCategory": {}
    }
  ],
  "links": {},
  "numErrors": 123,
  "requestedAt": "2023-11-07T05:31:56Z"
}

Productos compatibles

Se requiere uno de los siguientes productos o productos de ediciones superiores.
Marketing HubMarketing Hub -Starter
Sales HubSales Hub -Gratuito
Service HubService Hub -Gratuito
Content HubContent Hub -Gratuito

Autorizaciones

Authorization
string
header
requerido

The access token received from the authorization server in the OAuth 2.0 flow.

Parámetros de ruta

subscriberIdString
string
requerido

La dirección de correo electrónico del contacto.

Cuerpo

application/json
channel
enum<string>
requerido

El tipo de canal de comunicación, con 'EMAIL' como única opción admitida.

Opciones disponibles:
EMAIL
statusState
enum<string>
requerido

El estado de suscripción actual del contacto, que puede ser 'SUSCRIPTED', 'UNSUBSCRIBED' o 'NOT_SPECIFIED'.

Opciones disponibles:
NOT_SPECIFIED,
SUBSCRIBED,
UNSUBSCRIBED
subscriptionId
integer<int64>
requerido

El identificador único de la suscripción que se actualizará.

La base jurídica de la comunicación, con opciones que incluyen 'LEGITIMATE_INTEREST_PQL', 'LEGITIMATE_INTEREST_CLIENT', 'PERFORMANCE_OF_CONTRACT', 'CONSENT_WITH_NOTICE', 'NON_GDPR', 'PROCESS_AND_STORE', y 'LEGITIMATE_INTEREST_OTHER'.

Opciones disponibles:
CONSENT_WITH_NOTICE,
LEGITIMATE_INTEREST_CLIENT,
LEGITIMATE_INTEREST_OTHER,
LEGITIMATE_INTEREST_PQL,
NON_GDPR,
PERFORMANCE_OF_CONTRACT,
PROCESS_AND_STORE

Una explicación de la base jurídica utilizada para la comunicación.

Respuesta

successful operation

completedAt
string<date-time>
requerido

La fecha y la hora en que se completó la operación.

results
object[]
requerido

Una matriz de resultados de la operación.

startedAt
string<date-time>
requerido

La fecha y la hora en que se inició la operación.

status
enum<string>
requerido

Indica el estado actual de la operación, con los valores posibles: PENDIENTE, PROCESANDO, CANCELADO o COMPLETADO.

Opciones disponibles:
CANCELED,
COMPLETE,
PENDING,
PROCESSING
errors
object[]

Una lista de errores que se produjeron durante la operación.

Contiene URL relacionadas con la respuesta, como documentación o recursos.

numErrors
integer<int32>

El número de errores que se produjeron durante la operación.

requestedAt
string<date-time>

La fecha y hora en que se realizó la solicitud.

Last modified on March 30, 2026