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

# Batch unsubscribe contacts from all subscriptions

> Désabonner un ensemble de contacts de tous les abonnements aux e-mails.

> **Supported products**

> **Required Scopes**


## OpenAPI

````yaml specs/legacy/v4/communication-preferences-subscriptions-v4.json POST /communication-preferences/v4/statuses/batch/unsubscribe-all
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/unsubscribe-all:
    post:
      tags:
        - Status
      summary: Désabonner par lots les contacts de tous les abonnements
      description: Désabonner un ensemble de contacts de tous les abonnements aux e-mails.
      operationId: post-/communication-preferences/v4/statuses/batch/unsubscribe-all
      parameters:
        - name: channel
          in: query
          description: >-
            Le canal de communication à partir duquel se désabonner. Ce
            paramètre est obligatoire et doit être « EMAIL ».
          required: true
          style: form
          explode: true
          schema:
            type: string
            enum:
              - EMAIL
        - name: businessUnitId
          in: query
          description: >-
            L'ID de l'unité commerciale à laquelle l'opération s'applique. Il
            s'agit d'un paramètre facultatif.
          required: false
          style: form
          explode: true
          schema:
            type: integer
            format: int64
        - name: verbose
          in: query
          description: >-
            Un booléen indiquant s'il faut inclure des informations de
            traitement détaillées dans la réponse. La valeur par défaut est
            false.
          required: false
          style: form
          explode: true
          schema:
            type: boolean
            default: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchInputString'
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/BatchResponsePublicBulkOptOutFromAllResponse
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security:
        - oauth2:
            - communication_preferences.statuses.batch.write
components:
  schemas:
    BatchInputString:
      required:
        - inputs
      type: object
      properties:
        inputs:
          type: array
          description: >-
            Liste de chaînes représentant les entrées pour les opérations par
            lots.
          items:
            type: string
    BatchResponsePublicBulkOptOutFromAllResponse:
      required:
        - completedAt
        - results
        - startedAt
        - status
      type: object
      properties:
        completedAt:
          type: string
          description: >-
            La date et l'heure auxquelles l'opération de désinscription groupée
            a été effectuée.
          format: date-time
        errors:
          type: array
          description: >-
            Un tableau d'objets d'erreur détaillant tous les problèmes
            rencontrés lors de l'opération de désinscription groupée.
          items:
            $ref: '#/components/schemas/StandardError'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Une collection d'URL renvoyant vers des ressources ou de la
            documentation connexes.
        numErrors:
          type: integer
          description: >-
            Le nombre total d'erreurs rencontrées lors de l'opération de
            désinscription groupée.
          format: int32
        requestedAt:
          type: string
          description: >-
            La date et l'heure auxquelles la demande de désinscription groupée a
            été effectuée.
          format: date-time
        results:
          type: array
          description: >-
            Un tableau contenant les résultats de l'opération de désabonnement
            groupée de toutes les communications.
          items:
            $ref: '#/components/schemas/PublicBulkOptOutFromAllResponse'
        startedAt:
          type: string
          description: >-
            La date et l'heure auxquelles l'opération de désinscription groupée
            a commencé.
          format: date-time
        status:
          type: string
          description: >-
            Le statut actuel de l'opération de désinscription groupée, qui peut
            être EN ATTENTE, EN COURS DE TRAITEMENT, ANNULÉE ou TERMINÉE.
          enum:
            - CANCELED
            - COMPLETE
            - PENDING
            - PROCESSING
    StandardError:
      required:
        - category
        - context
        - errors
        - links
        - message
        - status
      type: object
      properties:
        category:
          type: string
          description: La catégorie principale de l'erreur.
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Informations contextuelles supplémentaires relatives à l'erreur.
        errors:
          type: array
          description: Les objets d'erreur détaillés.
          items:
            $ref: '#/components/schemas/ErrorDetail'
        id:
          type: string
          description: Un identifiant unique pour l'instance d'erreur.
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            URL renvoyant à la documentation ou aux ressources associées à
            l'erreur.
        message:
          type: string
          description: >-
            Chaîne lisible par l'homme décrivant l'erreur et les mesures
            correctives possibles.
        status:
          type: string
          description: "Un code de statut textuel pour l'erreur, généralement «\_error\_»."
        subCategory:
          type: object
          properties: {}
          description: >-
            Une catégorie d'erreurs plus spécifique au sein de chaque catégorie
            principale.
      description: >-
        Représente une réponse aux erreurs standard dans l'API HubSpot,
        fournissant des informations détaillées sur une erreur survenue lors
        d'une requête API.
    PublicBulkOptOutFromAllResponse:
      required:
        - subscriberIdString
      type: object
      properties:
        statuses:
          type: array
          description: >-
            Un tableau d'objets représentant le statut des abonnements pour le
            contact.
          items:
            $ref: '#/components/schemas/PublicStatus'
        subscriberIdString:
          type: string
          description: L'adresse e-mail du contact.
    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.
    PublicStatus:
      required:
        - channel
        - source
        - status
        - subscriberIdString
        - subscriptionId
        - timestamp
      type: object
      properties:
        businessUnitId:
          type: integer
          description: L'IDde l'unité commerciale associée à l'abonnement.
          format: int64
        channel:
          type: string
          description: "Le type de canal de communication, avec «\_E-MAIL\_» comme seule option prise en charge."
          enum:
            - EMAIL
        legalBasis:
          type: string
          description: "La base juridique de la communication, avec les options suivantes\_: «\_LEGITIMATE_INTEREST_PQL\_», «\_LEGITIMATE_INTEREST_CLIENT\_», «\_PERFORMANCE_OF_CONTRACT\_», «\_CONSENT_WITH_NOTICE\_», «\_NON_GDPR\_», «\_PROCESS_AND_STORE\_» et «\_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: Une explication de la base juridique utilisée pour la communication.
        setStatusSuccessReason:
          type: string
          description: "La raison du changement réussi du statut d'abonnement, telle que «\_RESUBSCRIBE_OCCURRED\_» ou «\_NO_STATUS_CHANGE\_»."
          enum:
            - NO_STATUS_CHANGE
            - REQUESTED_CHANGE_OCCURRED
            - RESUBSCRIBE_OCCURRED
            - UNSUBSCRIBE_FROM_ALL_OCCURRED
        source:
          type: string
          description: >-
            L'origine ou la méthode par laquelle le statut d'abonnement a été
            défini.
        status:
          type: string
          description: "Le statut d'abonnement actuel du contact, qui peut être «\_SUBSCRIBED\_», «\_UNSUBSCRIBED\_» ou «\_NOT_SPECIFIED\_»."
          enum:
            - NOT_SPECIFIED
            - SUBSCRIBED
            - UNSUBSCRIBED
        subscriberIdString:
          type: string
          description: L'adresse e-mail d'un contact.
        subscriptionId:
          type: integer
          description: L'identifiant unique de l'abonnement.
          format: int64
        subscriptionName:
          type: string
          description: Le nom de l'abonnement.
        timestamp:
          type: string
          description: >-
            La date et l'heure de la dernière mise à jour du statut de
            l'abonnement.
          format: date-time
  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: ''

````