> ## 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.

# Preferências de assinaturas v3

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>;
};

<RelatedApiLink />

<Accordion title="Requisitos de escopo">
  <ScopesList
    scopes={[
  'communication_preferences.read',
  'communication_preferences.read_write',
  'communication_preferences.write'
]}
  />
</Accordion>

Os tipos de assinatura representam a base jurídica para se comunicar com seus contatos por e-mail. Os contatos podem [gerenciar suas preferências](https://knowledge.hubspot.com/pt/marketing-email/insert-subscription-links-into-marketing-emails) de e-mail para que mantenham a assinatura somente dos e-mails que desejam receber.

<Warning>
  **Observação:** a API de preferências de assinatura<u>não</u> permite recuperar ou atualizar informações de assinatura do [WhatsApp](https://knowledge.hubspot.com/pt/inbox/collect-consent-for-whatsapp-conversations) para um contato.
</Warning>

## Obter status da assinatura do contato

O ponto de status da assinatura do contato permite aos usuários recuperar os status de assinatura de um endereço de e-mail em uma conta.

Esse endpoint é ideal para quando você tem uma central de preferências externa ou integração e precisa saber os status de assinatura de qualquer endereço de e-mail na sua conta.

***

## Assinar contato

O endpoint de contato de assinatura permite assinar um endereço de e-mail para qualquer tipo de assinatura em uma conta, \*\*mas não permite assinar os contatos que optaram por não aderir. \*\*

<Warning>
  **Observe o seguinte:** a nova versão da API do preferências de assinatura, v4, fornece suporte para a reinscrição de contatos que anteriormente optaram por não participar. Saiba mais sobre a função da API v4 [neste artigo](/api-reference/communication-preferences-subscriptions-v4/guide).
</Warning>

**Exemplo de caso de uso:** esse endpoint é ideal quando você tem uma integração ou um formulário externo que precisa optar por aderir contatos em um tipo de assinatura.

**Observação**: o endpoint de contato de assinatura deve ser usado apenas para honrar solicitações de contatos que forneceram permissão para assinar. [Revise as leis e regulamentos aplicáveis](https://knowledge.hubspot.com/pt/marketing-email/set-up-email-subscription-types) antes de inscrever um contato.

***

## Cancelar a assinatura do contato

O endpoint de contato do cancelamento de assinatura permite cancelar a assinatura de um endereço de e-mail em uma conta de qualquer tipo de assinatura determinado.

**Exemplo de caso de uso:** esse endpoint é ideal quando você tem uma integração ou um formulário externo que precisa cancelar a adesão de contatos em um tipo de assinatura.

***

## Obter tipos de assinatura

O endpoint de informação de assinatura permite que os usuários recuperem todos os tipos de assinatura em sua conta.

**Exemplo de caso de uso:** esse endpoint é ideal para quando você tem uma central de preferências externa, integração ou formulário e precisa saber os tipos de assinatura que existem em sua conta para atualizar os status de assinatura dos contatos de maneira correta.

***