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

# API de mise à jour d'une liste de conformité

> Renommez ou modifiez la description d'une liste Didit via PATCH /v3/lists/{list_uuid}/. Les listes système ne peuvent pas être modifiées.



Invite de l'API de mise à jour de liste
        Copier le prompt dans le presse-papiers



      
      

\<pre>

\`Rename a Didit list or update its description through the Management API.

Endpoint:
PATCH https://verification.didit.me/v3/lists/{list_uuid}/

Authentication:
Use the x-api-key header with my Didit API key. A scoped API key needs workflows: write.

Goal:
\- Update the editable metadata of an allowlist or custom list: name and description.
\- list_type and entry_type cannot change: any other field in the body is ignored. To change them, create a new list.
\- System lists (is_system: true) cannot be modified.

Path parameter:
\- list_uuid: the list UUID returned by GET /v3/lists/ or POST /v3/lists/.

Request body (application/json), send either field or both:
\{
"name": "Trusted office and VPN IPs",  // at most 255 characters, unique among the application's lists
"description": "Office egress ranges and the corporate VPN"
}

Example call:
curl -X PATCH "https://verification.didit.me/v3/lists/{list_uuid}/" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "Trusted office and VPN IPs"}'

Example response (200), only the editable fields:
\{
"name": "Trusted office and VPN IPs",
"description": "Office egress ranges"
}

Call GET /v3/lists/{list_uuid}/ when you need the full list after the update.

Failure modes:
\- 400: the list is a system list ({ "non_field_errors": ["System lists cannot be modified."] }), or the new name is empty, longer than 255 characters, or already used by another list of the application ({ "name": ["A list with this name already exists for this application."] }).
\- 401: the API key has expired.
\- 403: missing x-api-key (a wrong, revoked or expired key gets 401) ({ "detail": "You do not have permission to perform this action." }), or a scoped key without workflows: write.
\- 404: no list with this UUID in this application, or it was deleted.
\- 429: rate limited (see /integration/rate-limiting); back off and retry.

Side effects:
\- The new name and description are visible in the console and on subsequent GET calls immediately.

For the full integration shape, see /integration/integration-prompt.`

\</pre>



      
      

Coller dans

Mettez à jour le nom ou la description d'une liste. Tout autre champ du corps de la requête est ignoré, si bien que `list_type` et `entry_type` conservent les valeurs avec lesquelles elles ont été créées. Les listes système ne peuvent pas être modifiées et renvoient `400`.La réponse ne contient que `name` et `description`. Appelez [Obtenir la liste](https://docs.didit.me/fr/management-api/lists/get.md) pour obtenir la liste complète.


## OpenAPI

````yaml fr/openapi-25.json PATCH /v3/lists/{list_uuid}/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API de vérification d'identité. Authentifiez-vous avec l'en-tête x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/lists/{list_uuid}/:
    patch:
      tags:
        - Lists
      summary: Mettre à jour une liste
      description: >-
        Renomme une liste ou modifie sa description. Seuls `name` et
        `description` sont pris en compte ; tout autre champ est ignoré, de
        sorte que `list_type` et `entry_type` conservent les valeurs avec
        lesquelles ils ont été créés. Les listes système ne peuvent pas être
        modifiées et renvoient `400`. La réponse contient uniquement `name` et
        `description` : appelez [Get a
        list](https://docs.didit.me/fr/management-api/lists/get) pour obtenir la
        liste complète. Une clé API restreinte nécessite `workflows: write`.
      operationId: update_list
      parameters:
        - name: list_uuid
          in: path
          required: true
          description: >-
            UUID de la liste, tel que renvoyé par Lister les listes ou Créer une
            liste.
          schema:
            type: string
            format: uuid
          example: 11111111-2222-3333-4444-555555555555
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 255
                  description: >-
                    Nouveau nom. Doit différer du nom de toutes les autres
                    listes de l'application.
                description:
                  type: string
                  description: >-
                    Nouvelle description. Envoyez une chaîne vide pour
                    l'effacer.
            examples:
              Rename:
                value:
                  name: Trusted office and VPN IPs
              Rename and describe:
                value:
                  name: Trusted office and VPN IPs
                  description: Office egress ranges and the corporate VPN
      responses:
        '200':
          description: >-
            La liste a été mise à jour. Seuls les champs modifiables sont
            renvoyés.
          content:
            application/json:
              schema:
                type: object
                required:
                  - name
                  - description
                properties:
                  name:
                    type: string
                    description: Le nom de la liste après la mise à jour.
                  description:
                    type: string
                    description: La description de la liste après la mise à jour.
              examples:
                Renamed:
                  value:
                    name: Trusted office and VPN IPs
                    description: Office egress ranges
        '400':
          description: >-
            La liste est une liste système, ou le corps de la requête est
            invalide.
          content:
            application/json:
              examples:
                System list:
                  value:
                    non_field_errors:
                      - System lists cannot be modified.
                Duplicate name:
                  value:
                    name:
                      - >-
                        A list with this name already exists for this
                        application.
                Blank name:
                  value:
                    name:
                      - This field may not be blank.
        '401':
          description: >-
            La clé API restreinte a expiré. Les autres échecs d'authentification
            renvoient `403`.
          content:
            application/json:
              examples:
                Expired API key:
                  value:
                    detail: This API key has expired.
        '403':
          description: >-
            L'en-tête `x-api-key` est manquant (une clé incorrecte, révoquée ou
            expirée renvoie `401`), ou une clé API restreinte n'a pas
            l'autorisation `workflows: write` ou est utilisée depuis une adresse
            IP hors de sa liste d'autorisation.
          content:
            application/json:
              examples:
                Missing or invalid API key:
                  value:
                    detail: You do not have permission to perform this action.
                Scoped key without workflows access:
                  value:
                    detail: This API key has no write access to workflows.
        '404':
          description: >-
            Aucune liste avec cet UUID n'existe dans l'application de la clé
            API, ou elle a été supprimée.
          content:
            application/json:
              examples:
                Not found:
                  value:
                    detail: No List matches the given query.
        '429':
          $ref: '#/components/responses/RateLimitedWrite'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl -X PATCH
            'https://verification.didit.me/v3/lists/11111111-2222-3333-4444-555555555555/'
            \
              -H 'x-api-key: YOUR_API_KEY' \
              -H 'Content-Type: application/json' \
              -d '{"name": "Trusted office and VPN IPs"}'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.lists.update(
                "11111111-2222-3333-4444-555555555555",
                name="Trusted office and VPN IPs",
            )
            print(result)
        - lang: javascript
          label: Node.js
          source: >-
            import Didit from "@didit-protocol/sdk-node";


            // Reads DIDIT_API_KEY.

            const didit = new Didit();


            const result = await
            didit.lists.update("11111111-2222-3333-4444-555555555555", {
              name: "Trusted office and VPN IPs",
            });

            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Lists.Update(ctx, \"11111111-2222-3333-4444-555555555555\", didit.ListsUpdateParams{\n\tName: didit.String(\"Trusted office and VPN IPs\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: >-
            import me.didit.Didit;

            import me.didit.types.ListsUpdateParams;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result =
            client.lists().update("11111111-2222-3333-4444-555555555555",
            ListsUpdateParams.builder()
                    .name("Trusted office and VPN IPs")
                    .build());
            System.out.println(result);
        - lang: php
          label: PHP
          source: >-
            <?php


            require 'vendor/autoload.php';


            use Didit\DiditClient;


            // Reads DIDIT_API_KEY.

            $didit = new DiditClient();


            $result =
            $didit->lists->update('11111111-2222-3333-4444-555555555555', [
                'name' => 'Trusted office and VPN IPs',
            ]);

            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

            # Reads DIDIT_API_KEY.
            didit = Didit::Client.new

            result = didit.lists.update(
              "11111111-2222-3333-4444-555555555555",
              name: "Trusted office and VPN IPs"
            )
            puts result.to_h
        - lang: csharp
          label: .NET
          source: >-
            using System;

            using System.Text.Json;

            using Didit;


            // Reads DIDIT_API_KEY.

            using var client = new DiditClient();


            var result = await
            client.Lists.UpdateAsync("11111111-2222-3333-4444-555555555555", new
            ListsUpdateParams

            {
                Name = "Trusted office and VPN IPs",
            });

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  responses:
    RateLimitedWrite:
      description: >-
        La limite d'écriture partagée de 300 requêtes par minute et par clé API
        a été dépassée. Respectez l'en-tête `Retry-After` avant de réessayer.
      content:
        application/json:
          schema:
            type: object
            required:
              - detail
            properties:
              detail:
                type: string
          example:
            detail: >-
              Write request rate limit exceeded. You can make up to 300 requests
              per minute.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        La clé API de votre application, issue de Développeurs -> Clés API dans
        la Business Console. La clé principale dispose d'un accès complet. Une
        clé nommée peut être restreinte : aucun, lecture ou écriture par
        ressource, limitée à certains workflows ou aux sessions approuvées, à
        une liste d'adresses IP et à une date d'expiration. 401 signifie que la
        clé est incorrecte, révoquée ou expirée ; 403 signifie qu'aucune clé n'a
        été envoyée, que la clé n'a pas accès à cette ressource ou action, ou
        que la requête provient d'une adresse hors de sa liste d'IP ; 404 sur
        une route de session signifie que la session est hors des workflows ou
        des statuts de la clé. Une clé sans accès aux médias reçoit les URL
        d'images, de vidéos et de PDF à null, et une clé sans accès en écriture
        aux sessions reçoit les liens et tokens de session à null. Voir
        https://docs.didit.me/console/api-keys.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.