> ## 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 > Recuperar status de assinatura em lote para um conjunto de contatos. > **Supported products** > **Required Scopes** ## OpenAPI ````yaml specs/2026-03/communication-preferences-subscriptions-v2026-03.json POST /communication-preferences/2026-03/statuses/batch/read openapi: 3.0.1 info: title: Communication Preferences Subscriptions description: Basepom for all HubSpot Projects version: 2026-03 x-hubspot-product-tier-requirements: marketing: STARTER sales: FREE service: FREE cms: FREE commerce: FREE crmHub: FREE dataHub: FREE servers: - url: https://api.hubapi.com security: [] tags: - name: Batch - name: Definitions - name: Status paths: /communication-preferences/2026-03/statuses/batch/read: post: tags: - Batch summary: Recuperar status de assinatura em lote description: Recuperar status de assinatura em lote para um conjunto de contatos. operationId: post-/communication-preferences/2026-03/statuses/batch/read parameters: - name: channel in: query description: >- Uma string obrigatória que especifica o canal de comunicação. Atualmente, há suporte apenas a "EMAIL". required: true style: form explode: true schema: type: string enum: - EMAIL - name: businessUnitId in: query description: >- Um número inteiro opcional que representa o ID da unidade de negócios. Este parâmetro ajuda a filtrar os resultados com base em uma unidade de negócios específica. 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: Uma string que categoriza o tipo de erro. context: type: object additionalProperties: type: array items: type: string description: >- Um objeto que contém contexto adicional sobre a condição de erro, com chaves como nomes de contexto e valores como matrizes de strings. errors: type: array description: >- Uma matriz de objetos ErrorDetail que fornece mais informações sobre o erro. items: $ref: '#/components/schemas/ErrorDetail' id: type: string description: Uma string que representa o identificador exclusivo do erro. links: type: object additionalProperties: type: string description: >- Um objeto que mapeia 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 string contendo uma mensagem legível por humanos que descreve o erro. status: type: string description: Uma string que indica o status do erro. subCategory: type: object properties: {} description: Um objeto que fornece uma categorização mais específica do erro. description: Ye olde error 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 description: >- Representa uma resposta de erro retornada pela API quando uma operação falha. Este componente é usado em vários endpoints para fornecer informações detalhadas sobre o erro encontrado. 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 description: >- Representa informações detalhadas sobre um erro ocorrido na API. Este componente é usado para fornecer contexto e detalhes adicionais sobre os erros, geralmente como parte de uma resposta de 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: '' ````