Skip to main content
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 '{
  "statusState": "SUBSCRIBED",
  "channel": "EMAIL",
  "legalBasis": "LEGITIMATE_INTEREST_PQL",
  "subscriptionId": 123,
  "legalBasisExplanation": "<string>"
}'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "numErrors": 123,
  "requestedAt": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "links": {},
  "results": [
    {
      "subscriptionName": "<string>",
      "channel": "EMAIL",
      "subscriberIdString": "<string>",
      "legalBasis": "LEGITIMATE_INTEREST_PQL",
      "setStatusSuccessReason": "RESUBSCRIBE_OCCURRED",
      "source": "<string>",
      "subscriptionId": 123,
      "legalBasisExplanation": "<string>",
      "businessUnitId": 123,
      "status": "SUBSCRIBED",
      "timestamp": "2023-11-07T05:31:56Z"
    }
  ],
  "errors": [
    {
      "subCategory": "",
      "context": "",
      "links": "",
      "id": "",
      "category": "",
      "message": "",
      "errors": "",
      "status": ""
    }
  ],
  "status": "PENDING"
}

Productos compatibles

Se requiere uno de los siguientes productos o productos de ediciones superiores.
Marketing HubMarketing Hub -Gratuito
Sales HubSales Hub -Gratuito
Service HubService Hub -Gratuito
Content HubContent Hub -Gratuito
Esta API requiere uno de los siguientes ámbitos:
communication_preferences.read_write
communication_preferences.write

Authorizations

Authorization
string
header
required

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

Path Parameters

subscriberIdString
string
required

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

Body

application/json
statusState
enum<string>
required

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

Available options:
SUBSCRIBED,
UNSUBSCRIBED,
NOT_SPECIFIED
channel
enum<string>
required

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

Available options:
EMAIL
subscriptionId
integer
required

El identificador único de la suscripción que se va a 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'.

Available options:
LEGITIMATE_INTEREST_PQL,
LEGITIMATE_INTEREST_CLIENT,
PERFORMANCE_OF_CONTRACT,
CONSENT_WITH_NOTICE,
NON_GDPR,
PROCESS_AND_STORE,
LEGITIMATE_INTEREST_OTHER

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

Response

successful operation

completedAt
string<date-time>
required

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

startedAt
string<date-time>
required

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

results
object[]
required

Una matriz de resultados de la operación.

status
enum<string>
required

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

Available options:
PENDING,
PROCESSING,
CANCELED,
COMPLETE
numErrors
integer

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.

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

errors
object[]

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