Saltar al contenido principal
GET
/
communication-preferences
/
2026-03
/
statuses
/
{subscriberIdString}
Obtener las preferencias de suscripción de un contacto específico
curl --request GET \
  --url https://api.hubapi.com/communication-preferences/2026-03/statuses/{subscriberIdString} \
  --header 'Authorization: Bearer <token>'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "source": "<string>",
      "subscriberIdString": "<string>",
      "subscriptionId": 123,
      "timestamp": "2023-11-07T05:31:56Z",
      "businessUnitId": 123,
      "legalBasisExplanation": "<string>",
      "subscriptionName": "<string>"
    }
  ],
  "startedAt": "2023-11-07T05:31:56Z",
  "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"
}

Supported products

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

El identificador único del suscriptor cuyo estado de preferencias de comunicación se está obteniendo.

Parámetros de consulta

channel
enum<string>
requerido

El canal de comunicación para el cual se obtendrá el estado de suscripción. Este parámetro es obligatorio y actualmente solo admite "EMAIL".

Opciones disponibles:
EMAIL
businessUnitId
integer<int64>

El ID de la unidad de negocio para filtrar el estado de la suscripción. Este es un parámetro opcional.

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 May 11, 2026