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

# Generate subscription links

> Gere links de preferência de comunicação para um assinante. Este endpoint permite criar URLs para gerenciar preferências e cancelar a inscrição, o que é útil para integrar as preferências de comunicação em seus aplicativos. Saiba mais sobre [como gerar URLs de página de preferência e solucionar possíveis problemas](https://developers.hubspot.com/docs/api-reference/legacy/communication-preferences/generate-url-guide).

> **Supported products**

> **Required Scopes**


## OpenAPI

````yaml specs/legacy/v4/communication-preferences-subscriptions-v4.json POST /communication-preferences/v4/links/generate
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/links/generate:
    post:
      tags:
        - Status
      summary: Gerar links de assinatura
      description: >-
        Gere links de preferência de comunicação para um assinante. Este
        endpoint permite criar URLs para gerenciar preferências e cancelar a
        inscrição, o que é útil para integrar as preferências de comunicação em
        seus aplicativos. Saiba mais sobre [como gerar URLs de página de
        preferência e solucionar possíveis
        problemas](https://developers.hubspot.com/docs/api-reference/legacy/communication-preferences/generate-url-guide).
      operationId: >-
        post-/communication-preferences/v4/links/generate_/communication-preferences/v4/links/generate
      parameters:
        - name: channel
          in: query
          description: O canal de comunicação para o qual gerar links. Deve ser '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 a qual os links estão sendo gerados.
            O padrão é 0.
          required: false
          style: form
          explode: true
          schema:
            type: integer
            format: int64
            default: 0
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LinkGenerationRequest'
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkGenerationResponse'
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security:
        - oauth2:
            - communication_preferences.read_write
components:
  schemas:
    LinkGenerationRequest:
      required:
        - subscriberIdString
      type: object
      properties:
        language:
          type: string
          description: >-
            O idioma em que o link de preferência de comunicação deve ser
            apresentado, representado como uma string.
        subscriberIdString:
          type: string
          description: >-
            O identificador exclusivo do assinante, representado como uma
            string. Esta propriedade é obrigatória.
        subscriptionId:
          type: integer
          description: >-
            O identificador exclusivo da assinatura, representado como um número
            inteiro.
          format: int64
    LinkGenerationResponse:
      required:
        - managePreferencesUrl
        - subscriberIdString
        - unsubscribeAllUrl
      type: object
      properties:
        managePreferencesUrl:
          type: string
          description: >-
            Uma string de URL que direciona o assinante para uma página onde ele
            pode gerenciar suas preferências de comunicação.
        subscriberIdString:
          type: string
          description: >-
            O identificador exclusivo do assinante, representado como uma
            string.
        unsubscribeAllUrl:
          type: string
          description: >-
            Uma string de URL que permite ao assinante cancelar a inscrição de
            todas as comunicações.
        unsubscribeSingleUrl:
          type: string
          description: >-
            Uma string de URL que permite ao assinante cancelar a inscrição de
            um único tipo de comunicação.
    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
    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: ''

````