> For the complete documentation index, see [llms.txt](https://doc.commandersact.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.commandersact.com/fr/fonctionnalites/consent-management/rest-data-api/get-put-consents-preferences.md).

# GET/PUT Consents / préférences

## Consentements utilisateur

<mark style="color:bleu;">`GET`</mark> `https://api.commander1.com/engage/user/`

Cet endpoint vous permet de récupérer le consentement des catégories pour un utilisateur spécifique

#### Paramètres de requête

| Nom      | Type    | Description         |
| -------- | ------- | ------------------- |
| token    | string  | Jeton de sécurité   |
| user\_id | string  | ID de l'utilisateur |
| site     | integer | ID du site          |

{% tabs %}
{% tab title="200 Consentement récupéré avec succès." %}

```javascript
{
    "user_privacy_optin": 1,
    "user_privacy_categories": [
      "11",
      "12",
      "13"
    ]
}
```

{% endtab %}

{% tab title="404 Impossible de trouver un utilisateur correspondant à cette requête." %}

```javascript
{
    "message": "Personne introuvable"
}
```

{% endtab %}
{% endtabs %}

## Consentements visiteur

<mark style="color:bleu;">`GET`</mark> `https://api.commander1.com/v1.0/engage/visitors/`

Cet endpoint vous permet de récupérer le consentement des catégories pour un visiteur spécifique

#### Paramètres de requête

| Nom      | Type    | Description                                 |
| -------- | ------- | ------------------------------------------- |
| callback | string  | (optionnel) Callback pour une requête jsonp |
| token    | string  | Jeton de sécurité                           |
| site     | integer | ID du site                                  |
| tc\_id   | Chaîne  | Optionnel. ID cookie de l'utilisateur       |

{% tabs %}
{% tab title="200 Exemple de réponse avec optin" %}

```javascript
{
    "user_privacy_optin": 1,
    "user_privacy_categories": [
      "11",
      "12",
      "13"
    ]
}
```

{% endtab %}

{% tab title="202 Exemple de réponse avec optout" %}

```
{
    "user_privacy_optin": 0,
    "user_privacy_categories": []
}
```

{% endtab %}

{% tab title="404 " %}

```
{
    "message": "visiteur introuvable"
}
```

{% endtab %}
{% endtabs %}

## Utilisateur

<mark style="color:orange;">`PUT`</mark> `https://api.commander1.com/engage/user/`

Insérer ou mettre à jour une préférence dans la base de données (nécessite d'avoir le module DataCommander activé)

#### Paramètres de requête

| Nom      | Type   | Description                                                         |
| -------- | ------ | ------------------------------------------------------------------- |
| site     | string | ID du site (compte)                                                 |
| user\_id | string | ID de l'utilisateur. Requis si le paramètre tc\_id n'est pas défini |
| token    | string | Jeton de sécurité                                                   |

{% tabs %}
{% tab title="200 " %}

```
{"success":true}
```

{% endtab %}
{% endtabs %}

**Syntaxe et limites**

* Le payload JSON est représenté par une clé/valeur pour chaque préférence.
* Chaque propriété de préférence (clé) commence par "preferences." suivie du nom de la préférence : `preferences.your_preference_name`
* Le nom de la préférence ne doit pas contenir d'espace, de point ni de caractères spéciaux. Son format est `[A-Za-z0-9_-]`
* La valeur de la préférence peut contenir des espaces, des points, mais pas de caractères spéciaux.
* L'API accepte un **maximum de 20 préférences**

**Exemple de requête**

`PUT`

<https://api.commander1.com/engage/user/?site=1234\\&user\\_id=1234\\&token=WvNIX8955cnZ7WF0f632s0Wb99Ql3rtA>

```
{
  "preferences": {
    "news_monthly": true,
    "news_sales": true
  }
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://doc.commandersact.com/fr/fonctionnalites/consent-management/rest-data-api/get-put-consents-preferences.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.