> ## Documentation Index
> Fetch the complete documentation index at: https://developers.hubspot.es/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Batch retrieve contacts who have opted out of all communications

> Obtiene el estado de cancelación de la suscripción a todo de un lote de suscriptores en los canales especificados. Este punto de terminación es útil para verificar el estado de cancelación de suscripción de varios suscriptores en bloque, especialmente en canales de correo electrónico.

export const ScopesList = ({scopes = [], description = "Esta API requiere uno de los siguientes ámbitos:"}) => {
  if (!scopes || scopes.length === 0) {
    return null;
  }
  const sortedScopes = scopes.sort((a, b) => a.localeCompare(b));
  return <div>
      <div className="text-sm mb-2">{description}</div>
      <div>
        {sortedScopes.map((scope, index) => <div key={index}>
            <code>
              <span className="text-xs">{scope}</span>
            </code>
          </div>)}
      </div>
    </div>;
};

export const SupportedProducts = ({marketing, sales, service, cms, marketingLevel, salesLevel, serviceLevel, cmsLevel}) => {
  const translations = {
    header: "Productos compatibles",
    description: "Se requiere uno de los siguientes productos o productos de ediciones superiores.",
    productNames: {
      marketing: "Marketing Hub",
      sales: "Sales Hub",
      service: "Service Hub",
      cms: "Content Hub"
    },
    tiers: {
      free: "Gratuito",
      starter: "Starter",
      professional: "Pro",
      enterprise: "Enterprise"
    }
  };
  const translateTier = tier => {
    if (!tier) return '';
    const lowerTier = tier.toLowerCase();
    return translations.tiers[lowerTier] || tier;
  };
  const products = [{
    name: marketing ? translations.productNames.marketing : '',
    level: translateTier(marketingLevel),
    icon: "https://mintlify-assets.b-cdn.net/Icons/marketing-bolt.svg",
    alt: "Marketing Hub"
  }, {
    name: sales ? translations.productNames.sales : '',
    level: translateTier(salesLevel),
    icon: "https://mintlify-assets.b-cdn.net/Icons/sales-star.svg",
    alt: "Sales Hub"
  }, {
    name: service ? translations.productNames.service : '',
    level: translateTier(serviceLevel),
    icon: "https://mintlify-assets.b-cdn.net/Icons/service-heart.svg",
    alt: "Service Hub"
  }, {
    name: cms ? translations.productNames.cms : '',
    level: translateTier(cmsLevel),
    icon: "https://mintlify-assets.b-cdn.net/Icons/content-play.svg",
    alt: "Content Hub"
  }].filter(product => product.name && product.level);
  if (products.length === 0) return null;
  return <div>
      <div className="text-sm mb-2">{translations.description}</div>
      <div className={`grid ${products.length === 1 ? 'grid-cols-1' : 'grid-cols-2'} gap-1.5`}>
        {products.map((product, index) => <div key={index} style={{
    display: 'flex',
    alignItems: 'center'
  }}>
            <img src={product.icon} alt={product.alt} className="w-3.5 h-3.5 mr-1.5 mt-2.5 mb-2.5 flex-shrink-0 align-middle" />
            <span className="font-medium mr-1 text-sm">{product.name} -</span>
            <span className="text-sm">{product.level}</span>
          </div>)}
      </div>
    </div>;
};

<AccordionGroup>
  <Accordion title="Supported products" defaultOpen="true" icon="cubes">
    <SupportedProducts marketing={true} sales={true} service={true} cms={true} marketingLevel="STARTER" salesLevel="FREE" serviceLevel="FREE" cmsLevel="FREE" />
  </Accordion>

  <Accordion title="Required Scopes" icon="key">
    <ScopesList
      scopes={[
  'communication_preferences.statuses.batch.read'
]}
    />
  </Accordion>
</AccordionGroup>


## OpenAPI

````yaml specs/legacy/v4/communication-preferences-subscriptions-v4.json POST /communication-preferences/v4/statuses/batch/unsubscribe-all/read
openapi: 3.0.1
info:
  title: Communication Preferences Subscriptions
  description: Basepom for all HubSpot Projects
  version: v4
  x-hubspot-product-tier-requirements:
    marketing: STARTER
    sales: FREE
    service: FREE
    cms: FREE
    commerce: FREE
    crmHub: FREE
    dataHub: FREE
  x-hubspot-related-documentation:
    - name: Subscriptions preferences guide
      url: https://developers.hubspot.com/docs/guides/api/marketing/subscriptions
servers:
  - url: https://api.hubapi.com
security: []
tags:
  - name: Definitions
  - name: Status
paths:
  /communication-preferences/v4/statuses/batch/unsubscribe-all/read:
    post:
      tags:
        - Status
      summary: Leer estados por lotes
      description: >-
        Obtiene el estado de cancelación de la suscripción a todo de un lote de
        suscriptores en los canales especificados. Este punto de terminación es
        útil para verificar el estado de cancelación de suscripción de varios
        suscriptores en bloque, especialmente en canales de correo electrónico.
      operationId: post-/communication-preferences/v4/statuses/batch/unsubscribe-all/read
      parameters:
        - name: channel
          in: query
          description: >-
            El canal de comunicación en el que verificar el estado de
            cancelación de suscripción. Este parámetro es obligatorio y
            actualmente solo admite "EMAIL".
          required: true
          style: form
          explode: true
          schema:
            type: string
            enum:
              - EMAIL
        - name: businessUnitId
          in: query
          description: El ID de la unidad de negocio. Este es un parámetro opcional.
          required: false
          style: form
          explode: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchInputString'
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchResponsePublicWideStatusBulkResponse'
        '207':
          description: multiple statuses
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/BatchResponsePublicWideStatusBulkResponseWithErrors
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security:
        - oauth2:
            - communication_preferences.statuses.batch.read
components:
  schemas:
    BatchInputString:
      required:
        - inputs
      type: object
      properties:
        inputs:
          type: array
          description: >-
            Una lista de cadenas que representan las entradas para las
            operaciones por lotes.
          items:
            type: string
    BatchResponsePublicWideStatusBulkResponse:
      required:
        - completedAt
        - results
        - startedAt
        - status
      type: object
      properties:
        completedAt:
          type: string
          description: La fecha y hora en que se completó el proceso por lotes.
          format: date-time
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Una recopilación de enlaces relacionados asociados con la respuesta
            por lotes.
        requestedAt:
          type: string
          description: La fecha y hora en que se realizó la solicitud por lotes.
          format: date-time
        results:
          type: array
          description: >-
            La matriz de resultados del proceso por lotes, cada uno de los
            cuales contiene información sobre el estado de la suscripción.
          items:
            $ref: '#/components/schemas/PublicWideStatusBulkResponse'
        startedAt:
          type: string
          description: La fecha y la hora en que comenzó el proceso por lotes.
          format: date-time
        status:
          type: string
          description: >-
            El estado actual del proceso por lotes, que puede ser: PENDIENTE,
            PROCESANDO, CANCELADO o COMPLETADO.
          enum:
            - CANCELED
            - COMPLETE
            - PENDING
            - PROCESSING
    BatchResponsePublicWideStatusBulkResponseWithErrors:
      required:
        - completedAt
        - results
        - startedAt
        - status
      type: object
      properties:
        completedAt:
          type: string
          description: La fecha y la hora en que se completó la operación.
          format: date-time
        errors:
          type: array
          description: >-
            Una matriz de objetos de error que detalla cualquier problema
            encontrado durante la operación.
          items:
            $ref: '#/components/schemas/StandardError'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Un objeto que contiene enlaces relacionados, donde cada clave es un
            nombre de enlace y cada valor es una URL.
        numErrors:
          type: integer
          description: El número de errores encontrados durante la operación.
          format: int32
        requestedAt:
          type: string
          description: La fecha y la hora en que se solicitó la operación.
          format: date-time
        results:
          type: array
          description: Una matriz que contiene los resultados de la operación.
          items:
            $ref: '#/components/schemas/PublicWideStatusBulkResponse'
        startedAt:
          type: string
          description: La fecha y la hora en que se inició la operación.
          format: date-time
        status:
          type: string
          description: >-
            El estado actual de la operación, puede ser PENDIENTE, PROCESANDO,
            CANCELADO o COMPLETADO.
          enum:
            - CANCELED
            - COMPLETE
            - PENDING
            - PROCESSING
    PublicWideStatusBulkResponse:
      required:
        - subscriberIdString
        - wideStatuses
      type: object
      properties:
        subscriberIdString:
          type: string
          description: La dirección de correo electrónico del contacto.
        wideStatuses:
          type: array
          description: >-
            Una matriz que contiene los resultados de estado amplio para la
            operación.
          items:
            $ref: '#/components/schemas/PublicWideStatus'
    StandardError:
      required:
        - category
        - context
        - errors
        - links
        - message
        - status
      type: object
      properties:
        category:
          type: string
          description: La categoría principal del error.
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: >-
            Información adicional específica del contexto relacionada con el
            error.
        errors:
          type: array
          description: Los objetos de error detallados.
          items:
            $ref: '#/components/schemas/ErrorDetail'
        id:
          type: string
          description: El ID único de la instancia del error.
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Las URL que enlazan a la documentación o a los recursos asociados
            con el error.
        message:
          type: string
          description: >-
            Un mensaje legible para humanos en el que se describa el error y los
            pasos para solucionarlo.
        status:
          type: string
          description: El código de estado HTTP asociado al error.
        subCategory:
          type: object
          properties: {}
          description: >-
            Una categoría de error más específica dentro de cada categoría
            principal.
      description: >-
        Representa una respuesta de error estándar en la API de HubSpot, que
        proporciona información detallada sobre un error que ocurrió durante una
        solicitud a la API.
    Error:
      required:
        - category
        - correlationId
        - message
      type: object
      properties:
        category:
          type: string
          description: La categoría del error
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexto de la condición de error
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        correlationId:
          type: string
          description: >-
            Un identificador único para la solicitud. Incluye este valor con
            cualquier informe de error o ticket de asistencia.
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: información adicional acerca del error
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Un mapa de nombres de enlaces a las URI asociadas que contienen
            documentación sobre el error o los pasos recomendados para
            solucionarlo
        message:
          type: string
          description: >-
            Un mensaje legible en el que se describa el error y los pasos para
            solucionarlo, si procede
          example: An error occurred
        subCategory:
          type: string
          description: >-
            Una categoría específica que contiene detalles más concretos acerca
            del error
      example:
        message: Invalid input (details will vary based on the error)
        correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
        category: VALIDATION_ERROR
        links:
          knowledge-base: https://www.hubspot.com/products/service/knowledge-base
    PublicWideStatus:
      required:
        - channel
        - status
        - subscriberIdString
        - timestamp
        - wideStatusType
      type: object
      properties:
        businessUnitId:
          type: integer
          description: La ID de la unidad de negocio asociada al estado.
          format: int64
        channel:
          type: string
          description: >-
            El tipo de canal de comunicación, con 'EMAIL' como única opción
            admitida.
          enum:
            - EMAIL
        status:
          type: string
          description: >-
            El estado de la suscripción del contacto, que puede ser
            'SUBSCRIBED', 'UNSUBSCRIBED' o 'NOT_SPECIFIED'.
          enum:
            - NOT_SPECIFIED
            - SUBSCRIBED
            - UNSUBSCRIBED
        subscriberIdString:
          type: string
          description: La dirección de correo del contacto.
        timestamp:
          type: string
          description: La fecha y hora en que se registró el estado.
          format: date-time
        wideStatusType:
          type: string
          description: >-
            El tipo de estado amplio, que puede ser 'PORTAL_WIDE' o
            'BUSINESS_UNIT_WIDE'.
          enum:
            - BUSINESS_UNIT_WIDE
            - PORTAL_WIDE
    ErrorDetail:
      required:
        - message
      type: object
      properties:
        code:
          type: string
          description: El código de estado asociado al detalle del error
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexto de la condición de error
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: El nombre del campo o parámetro en el que se encontró el error.
        message:
          type: string
          description: >-
            Un mensaje legible en el que se describa el error y los pasos para
            solucionarlo, si procede
        subCategory:
          type: string
          description: >-
            Una categoría específica que contiene detalles más concretos acerca
            del error
  responses:
    Error:
      description: An error occurred.
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.hubspot.com/oauth/authorize
          tokenUrl: https://api.hubapi.com/oauth/v1/token
          scopes:
            communication_preferences.read_write: ''
            communication_preferences.statuses.batch.read: ''
            communication_preferences.statuses.batch.write: ''

````