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

# Batch retrieve subscription statuses

> Obtenha os status das preferências de comunicação para um lote de assinantes. Este endpoint permite verificar o status da assinatura em um canal especificado para vários assinantes de uma só vez. É útil para gerenciar e auditar as preferências dos assinantes em massa.

export const ScopesList = ({scopes = [], description = "Esta API requer um dos seguintes escopos:"}) => {
  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: "Produtos suportados",
    description: "Requer um dos seguintes produtos ou superior.",
    productNames: {
      marketing: "Marketing Hub",
      sales: "Sales Hub",
      service: "Service Hub",
      cms: "Content Hub"
    },
    tiers: {
      free: "Grátis",
      starter: "Starter",
      professional: "Professional",
      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/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/read:
    post:
      tags:
        - Status
      summary: Ler status em lote
      description: >-
        Obtenha os status das preferências de comunicação para um lote de
        assinantes. Este endpoint permite verificar o status da assinatura em um
        canal especificado para vários assinantes de uma só vez. É útil para
        gerenciar e auditar as preferências dos assinantes em massa.
      operationId: post-/communication-preferences/v4/statuses/batch/read
      parameters:
        - name: channel
          in: query
          description: >-
            Uma string obrigatória que indica o canal de comunicação para
            filtrar. O valor válido é 'EMAIL'.
          required: true
          style: form
          explode: true
          schema:
            type: string
            enum:
              - EMAIL
        - name: businessUnitId
          in: query
          description: >-
            O ID da unidade de negócio para filtrar os status. É um número
            inteiro.
          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/BatchResponsePublicStatusBulkResponse'
        '207':
          description: multiple statuses
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/BatchResponsePublicStatusBulkResponseWithErrors
        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: >-
            Uma lista de strings que representam as entradas para operações em
            lote.
          items:
            type: string
    BatchResponsePublicStatusBulkResponse:
      required:
        - completedAt
        - results
        - startedAt
        - status
      type: object
      properties:
        completedAt:
          type: string
          description: A data e a hora em que a solicitação em lote foi concluída.
          format: date-time
        links:
          type: object
          additionalProperties:
            type: string
          description: Uma coleção de links relacionados associados à resposta em lote.
        requestedAt:
          type: string
          description: A data e a hora em que a solicitação em lote foi feita.
          format: date-time
        results:
          type: array
          description: >-
            A série de resultados do processo em lote, cada um contendo
            informações de status da assinatura.
          items:
            $ref: '#/components/schemas/PublicStatusBulkResponse'
        startedAt:
          type: string
          description: A data e a hora em que a solicitação em lote começou.
          format: date-time
        status:
          type: string
          description: >-
            O status atual do processo em lote, com valores possíveis: PENDING,
            PROCESSING, CANCELED, COMPLETE.
          enum:
            - CANCELED
            - COMPLETE
            - PENDING
            - PROCESSING
    BatchResponsePublicStatusBulkResponseWithErrors:
      required:
        - completedAt
        - results
        - startedAt
        - status
      type: object
      properties:
        completedAt:
          type: string
          description: A data e a hora em que a operação foi concluída.
          format: date-time
        errors:
          type: array
          description: >-
            Uma série de objetos de erro detalhando quaisquer problemas
            encontrados durante a operação.
          items:
            $ref: '#/components/schemas/StandardError'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Um objeto que contém links relacionados, onde cada chave é um nome
            de link e cada valor é um URL.
        numErrors:
          type: integer
          description: O número de erros encontrados durante a operação.
          format: int32
        requestedAt:
          type: string
          description: A data e a hora em que a solicitação foi feita.
          format: date-time
        results:
          type: array
          description: Uma série contendo os resultados da operação.
          items:
            $ref: '#/components/schemas/PublicStatusBulkResponse'
        startedAt:
          type: string
          description: A data e a hora em que a operação começou.
          format: date-time
        status:
          type: string
          description: >-
            O status atual da operação, que pode ser PENDING, PROCESSING,
            CANCELED ou COMPLETE.
          enum:
            - CANCELED
            - COMPLETE
            - PENDING
            - PROCESSING
    PublicStatusBulkResponse:
      required:
        - statuses
        - subscriberIdString
      type: object
      properties:
        statuses:
          type: array
          description: Uma série de objetos de status de assinatura para o contato.
          items:
            $ref: '#/components/schemas/PublicStatus'
        subscriberIdString:
          type: string
          description: O endereço de e-mail do contato.
    StandardError:
      required:
        - category
        - context
        - errors
        - links
        - message
        - status
      type: object
      properties:
        category:
          type: string
          description: A categoria principal do erro.
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Informações adicionais específicas do contexto relacionadas ao erro.
        errors:
          type: array
          description: Os objetos de erro detalhados.
          items:
            $ref: '#/components/schemas/ErrorDetail'
        id:
          type: string
          description: Um ID exclusivo para a instância de erro.
        links:
          type: object
          additionalProperties:
            type: string
          description: URLs com links para documentação ou recursos associados ao erro.
        message:
          type: string
          description: >-
            Uma string legível que descreve o erro e possíveis etapas de
            correção.
        status:
          type: string
          description: O código de status HTTP associado ao erro.
        subCategory:
          type: object
          properties: {}
          description: >-
            Uma categoria de erro mais específica dentro de cada categoria
            principal.
      description: >-
        Representa uma resposta de erro padrão na API do HubSpot, fornecendo
        informações detalhadas sobre um erro ocorrido durante uma solicitação de
        API.
    Error:
      required:
        - category
        - correlationId
        - message
      type: object
      properties:
        category:
          type: string
          description: A categoria de erro
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexto sobre a condição do erro
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        correlationId:
          type: string
          description: >-
            Um identificador exclusivo para a solicitação. Inclua este valor em
            relatórios de erro ou tickets de suporte
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: mais informações sobre o erro
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Um mapa de nomes de links para URIs associados que contêm
            documentação sobre o erro ou as etapas de correção recomendadas
        message:
          type: string
          description: >-
            Uma mensagem legível por humanos que descreve o erro, juntamente com
            as etapas de correção, quando apropriado
          example: An error occurred
        subCategory:
          type: string
          description: >-
            Uma categoria específica que contém mais detalhes específicos sobre
            o erro
      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
    PublicStatus:
      required:
        - channel
        - source
        - status
        - subscriberIdString
        - subscriptionId
        - timestamp
      type: object
      properties:
        businessUnitId:
          type: integer
          description: O ID da unidade de negócios associada à assinatura.
          format: int64
        channel:
          type: string
          description: >-
            O tipo de canal de comunicação, com "EMAIL" como a única opção
            suportada.
          enum:
            - EMAIL
        legalBasis:
          type: string
          description: >-
            A base jurídica para comunicação, com opções incluindo
            "LEGITIMATE_INTEREST_PQL", "LEGITIMATE_INTEREST_CLIENT",
            "PERFORMANCE_OF_CONTRACT", "CONSENT_WITH_NOTICE", "NON_GDPR",
            "PROCESS_AND_STORE" e "LEGITIMATE_INTEREST_OTHER".
          enum:
            - CONSENT_WITH_NOTICE
            - LEGITIMATE_INTEREST_CLIENT
            - LEGITIMATE_INTEREST_OTHER
            - LEGITIMATE_INTEREST_PQL
            - NON_GDPR
            - PERFORMANCE_OF_CONTRACT
            - PROCESS_AND_STORE
        legalBasisExplanation:
          type: string
          description: Uma explicação para a base jurídica usada para comunicação.
        setStatusSuccessReason:
          type: string
          description: >-
            O motivo da mudança bem-sucedida no status da assinatura, como
            "RESUBSCRIBE_OCCURRED" ou "NO_STATUS_CHANGE".
          enum:
            - NO_STATUS_CHANGE
            - REQUESTED_CHANGE_OCCURRED
            - RESUBSCRIBE_OCCURRED
            - UNSUBSCRIBE_FROM_ALL_OCCURRED
        source:
          type: string
          description: A origem ou método pelo qual o status da assinatura foi definido.
        status:
          type: string
          description: >-
            O status atual da assinatura do contato, que pode ser "SUBSCRIBED",
            "UNSUBSCRIBED" ou "NOT_SPECIFIED".
          enum:
            - NOT_SPECIFIED
            - SUBSCRIBED
            - UNSUBSCRIBED
        subscriberIdString:
          type: string
          description: O endereço de e-mail do contato.
        subscriptionId:
          type: integer
          description: O identificador exclusivo da assinatura.
          format: int64
        subscriptionName:
          type: string
          description: O nome da assinatura.
        timestamp:
          type: string
          description: >-
            A data e a hora em que o status da assinatura foi atualizado pela
            última vez.
          format: date-time
    ErrorDetail:
      required:
        - message
      type: object
      properties:
        code:
          type: string
          description: O código de status associado ao detalhe do erro
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexto sobre a condição do erro
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: O nome do campo ou parâmetro no qual o erro foi encontrado.
        message:
          type: string
          description: >-
            Uma mensagem legível por humanos que descreve o erro, juntamente com
            as etapas de correção, quando apropriado
        subCategory:
          type: string
          description: >-
            Uma categoria específica que contém mais detalhes específicos sobre
            o erro
  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: ''

````