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

# Retrieve a contact's unsubscribed status

> Vérifie si un contact s'est désabonné de tous les abonnements aux e-mails. Si un contact ne s'est pas désabonné de toutes les communications, le tableau « résultats » de la réponse sera vide.

> **Supported products**

> **Required Scopes**


## OpenAPI

````yaml specs/legacy/v4/communication-preferences-subscriptions-v4.json GET /communication-preferences/v4/statuses/{subscriberIdString}/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/{subscriberIdString}/unsubscribe-all:
    get:
      tags:
        - Status
      summary: Récupérer le statut de désabonnement d'un contact
      description: "Vérifie si un contact s'est désabonné de tous les abonnements aux e-mails. Si un contact ne s'est pas désabonné de toutes les communications, le tableau «\_résultats\_» de la réponse sera vide."
      operationId: >-
        get-/communication-preferences/v4/statuses/{subscriberIdString}/unsubscribe-all
      parameters:
        - name: subscriberIdString
          in: path
          description: >-
            L'identifiant unique de l'abonné(e) dont le statut de désabonnement
            est récupéré.
          required: true
          style: simple
          explode: false
          schema:
            type: string
        - name: channel
          in: query
          description: >-
            Le canal de communication à partir duquel se désabonner. 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. Il s'agit d'un paramètre entier
            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 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
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActionResponseWithResultsPublicWideStatus'
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security:
        - oauth2:
            - communication_preferences.read_write
components:
  schemas:
    ActionResponseWithResultsPublicWideStatus:
      required:
        - completedAt
        - results
        - startedAt
        - status
      type: object
      properties:
        completedAt:
          type: string
          description: La date et l'heure de la fin de l'opération.
          format: date-time
        errors:
          type: array
          description: >-
            Un tableau d'objets d'erreur détaillant tous les problèmes
            rencontrés pendant l'opération.
          items:
            $ref: '#/components/schemas/StandardError'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Un objet contenant des liens connexes, où chaque clé est un nom de
            lien et chaque valeur est une URL.
        numErrors:
          type: integer
          description: Le nombre d'erreurs rencontrées pendant l'opération.
          format: int32
        requestedAt:
          type: string
          description: La date et l'heure auxquelles la demande a été faite.
          format: date-time
        results:
          type: array
          description: Un tableau contenant les résultats de l'opération.
          items:
            $ref: '#/components/schemas/PublicWideStatus'
        startedAt:
          type: string
          description: La date et l'heure du début de l'opération.
          format: date-time
        status:
          type: string
          description: >-
            Le statut actuel de l'opération, 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.
    PublicWideStatus:
      required:
        - channel
        - status
        - subscriberIdString
        - timestamp
        - wideStatusType
      type: object
      properties:
        businessUnitId:
          type: integer
          description: L'ID de l'unité commerciale associée au statut.
          format: int64
        channel:
          type: string
          description: "Le type de canal de communication, avec «\_E-MAIL\_» comme seule option prise en charge."
          enum:
            - EMAIL
        status:
          type: string
          description: "Le statut d'abonnement du contact, qui peut être «\_SUBSCRIBED\_», «\_UNSUBSCRIBED\_» ou «\_NOT_SPECIFIED\_»."
          enum:
            - NOT_SPECIFIED
            - SUBSCRIBED
            - UNSUBSCRIBED
        subscriberIdString:
          type: string
          description: L'adresse e-mail du contact.
        timestamp:
          type: string
          description: La date et l'heure auxquelles le statut a été enregistré.
          format: date-time
        wideStatusType:
          type: string
          description: "Le type de statut global, qui peut être «\_PORTAL_WIDE\_» ou «\_BUSINESS_UNIT_WIDE\_»."
          enum:
            - BUSINESS_UNIT_WIDE
            - PORTAL_WIDE
    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: ''

````