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

# Generate subscription links

> Générez des liens de préférences de communication pour un abonné. Ce point de terminaison vous permet de créer des URL pour gérer les préférences et vous désabonner, ce qui est utile pour intégrer les préférences de communication dans vos applications. Apprenez-en davantage sur la [génération d'URL de page de préférences et la résolution des problèmes potentiels](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: Générer des liens d'abonnement
      description: >-
        Générez des liens de préférences de communication pour un abonné. Ce
        point de terminaison vous permet de créer des URL pour gérer les
        préférences et vous désabonner, ce qui est utile pour intégrer les
        préférences de communication dans vos applications. Apprenez-en
        davantage sur la [génération d'URL de page de préférences et la
        résolution des problèmes
        potentiels](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: >-
            Le canal de communication pour lequel générer des liens. Doit être «
            EMAIL ».
          required: true
          style: form
          explode: true
          schema:
            type: string
            enum:
              - EMAIL
        - name: businessUnitId
          in: query
          description: >-
            L'identifiant de l'unité commerciale pour laquelle les liens sont
            générés. La valeur par défaut est 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: >-
            La langue dans laquelle le lien de préférence de communication doit
            être présenté, représentée sous forme de chaîne de caractères.
        subscriberIdString:
          type: string
          description: >-
            L'identifiant unique de l'abonné, représenté sous forme de chaîne de
            caractères. Cette propriété est requise.
        subscriptionId:
          type: integer
          description: >-
            L'identifiant unique de l'abonnement, représenté sous forme d'un
            nombre entier.
          format: int64
    LinkGenerationResponse:
      required:
        - managePreferencesUrl
        - subscriberIdString
        - unsubscribeAllUrl
      type: object
      properties:
        managePreferencesUrl:
          type: string
          description: >-
            Chaîne d'URL qui dirige l'abonné(e) vers une page où il/elle peut
            gérer ses préférences de communication.
        subscriberIdString:
          type: string
          description: >-
            L'identifiant unique de l'abonné, représenté sous forme de chaîne de
            caractères.
        unsubscribeAllUrl:
          type: string
          description: >-
            Une chaîne d'URL qui permet à l'abonné(e) de se désabonner de toutes
            les communications.
        unsubscribeSingleUrl:
          type: string
          description: >-
            Une chaîne d'URL qui permet à l'abonné(e) de se désabonner d'un seul
            type de communication.
    Error:
      required:
        - category
        - correlationId
        - message
      type: object
      properties:
        category:
          type: string
          description: La catégorie d'erreur
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexte concernant la condition d'erreur
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        correlationId:
          type: string
          description: >-
            Un identifiant unique pour la demande. Incluez cette valeur dans
            tous les rapports d'erreurs ou tickets d'assistance
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: informations supplémentaires à propos de l'erreur
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Une carte des noms de liens vers les URI associés contenant de la
            documentation sur l'erreur ou les mesures correctives recommandées
        message:
          type: string
          description: >-
            Un message lisible par la personne décrivant l'erreur ainsi que les
            mesures correctives possibles, le cas échéant
          example: An error occurred
        subCategory:
          type: string
          description: >-
            Une catégorie spécifique qui contient des détails plus précis sur
            l'erreur
      description: >-
        Représente une réponse d'erreur renvoyée par l'API lorsqu'une opération
        échoue. Ce composant est utilisé dans divers points de terminaison pour
        fournir des informations détaillées sur l'erreur rencontrée.
      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: Le code du statut associé au détail de l'erreur
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexte concernant la condition d'erreur
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: Le nom du champ ou du paramètre dans lequel l'erreur a été trouvée.
        message:
          type: string
          description: >-
            Un message lisible par la personne décrivant l'erreur ainsi que les
            mesures correctives possibles, le cas échéant
        subCategory:
          type: string
          description: >-
            Une catégorie spécifique qui contient des détails plus précis sur
            l'erreur
      description: >-
        Représente des informations détaillées sur une erreur survenue dans
        l'API. Ce composant est utilisé pour fournir un contexte et des
        spécificités supplémentaires sur les erreurs, généralement dans le cadre
        d'une réponse d'erreur.
  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: ''

````