Skip to main content
GET
/
communication-preferences
/
v4
/
statuses
/
{subscriberIdString}
Obtener las preferencias de suscripción de un contacto específico
curl --request GET \
  --url https://api.hubapi.com/communication-preferences/v4/statuses/{subscriberIdString} \
  --header 'Authorization: Bearer <token>'
{
  "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
communication_preferences.read_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.

Query Parameters

businessUnitId
integer

Si tienes el complemento unidad de negocio, incluye este parámetro para filtrar los resultados por el ID de la unidad de negocio. La unidad de negocio predeterminada de la cuenta siempre utilizará 0.

channel
enum<string>
required

El tipo de canal para el tipo de suscripción. Actualmente el único tipo de canal admitido es EMAIL.

Available options:
EMAIL

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.