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

# Update List API: Ubah Daftar Kepatuhan

> PATCH /v3/lists/{list_uuid}/: ubah nama atau deskripsi daftar izin atau daftar kustom Didit. Daftar sistem tidak dapat diubah.



Prompt API untuk Memperbarui Daftar
        Salin prompt ke papan klip



      
      

\<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>



      
      

Tempel ke

Perbarui nama atau deskripsi daftar. Kolom lain dalam isi permintaan akan diabaikan, sehingga `list_type` dan `entry_type` tetap menggunakan nilai saat daftar dibuat. Daftar sistem tidak dapat diubah dan akan mengembalikan `400`.Respons hanya berisi `name` dan `description`. Panggil [Dapatkan daftar](https://docs.didit.me/id/management-api/lists/get.md) untuk melihat daftar lengkap.


## OpenAPI

````yaml id/openapi-25.json PATCH /v3/lists/{list_uuid}/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API Verifikasi Identitas. Lakukan autentikasi dengan header x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/lists/{list_uuid}/:
    patch:
      tags:
        - Lists
      summary: Perbarui daftar
      description: >-
        Mengubah nama daftar atau mengubah deskripsinya. Hanya `name` dan
        `description` yang dibaca; kolom lainnya diabaikan, sehingga `list_type`
        dan `entry_type` tetap mempertahankan nilai saat dibuat. Daftar sistem
        tidak dapat dimodifikasi dan mengembalikan `400`. Respons hanya berisi
        `name` dan `description`: panggil [Dapatkan
        daftar](https://docs.didit.me/id/management-api/lists/get) untuk daftar
        lengkapnya. Kunci API terbatas memerlukan `workflows: write`.
      operationId: update_list
      parameters:
        - name: list_uuid
          in: path
          required: true
          description: >-
            UUID daftar, seperti yang dikembalikan oleh Cantumkan daftar atau
            Buat daftar.
          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: >-
                    Nama baru. Harus berbeda dari nama setiap daftar lain pada
                    aplikasi.
                description:
                  type: string
                  description: Deskripsi baru. Kirim string kosong untuk menghapusnya.
            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: >-
            Daftar telah diperbarui. Hanya kolom yang dapat diedit yang
            dikembalikan.
          content:
            application/json:
              schema:
                type: object
                required:
                  - name
                  - description
                properties:
                  name:
                    type: string
                    description: Nama daftar setelah pembaruan.
                  description:
                    type: string
                    description: Deskripsi daftar setelah pembaruan.
              examples:
                Renamed:
                  value:
                    name: Trusted office and VPN IPs
                    description: Office egress ranges
        '400':
          description: Daftar ini adalah daftar sistem, atau isi permintaan tidak valid.
          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: >-
            Kunci API dengan cakupan terbatas telah kedaluwarsa. Kegagalan
            autentikasi lainnya mengembalikan `403`.
          content:
            application/json:
              examples:
                Expired API key:
                  value:
                    detail: This API key has expired.
        '403':
          description: >-
            Header `x-api-key` tidak ada (kunci yang salah, dicabut, atau
            kedaluwarsa menghasilkan `401`), atau kunci API dengan cakupan
            tertentu tidak memiliki `workflows: write` atau digunakan dari
            alamat IP di luar daftar izinnya.
          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: >-
            Tidak ada daftar dengan UUID ini di aplikasi milik kunci API, atau
            daftar tersebut telah dihapus.
          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: >-
        Batas tulis bersama sebesar 300 permintaan per menit per kunci API telah
        terlampaui. Patuhi `Retry-After` sebelum mencoba lagi.
      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: >-
        Kunci API aplikasi Anda, dari Developers -> API keys di Business
        Console. Kunci utama memiliki akses penuh. Kunci bernama dapat diberi
        cakupan: none, read, atau write per sumber daya, dibatasi pada beberapa
        alur kerja atau pada sesi yang disetujui, pada daftar alamat IP, dan
        pada tanggal kedaluwarsa. 401 berarti kuncinya salah, dicabut, atau
        kedaluwarsa; 403 berarti tidak ada kunci yang dikirimkan, kunci tidak
        memiliki akses ke sumber daya atau tindakan ini, atau permintaan datang
        dari alamat di luar daftar IP-nya; 404 pada rute sesi berarti sesi
        berada di luar alur kerja atau status kunci tersebut. Kunci tanpa akses
        media menerima URL gambar, video, dan PDF sebagai null, dan kunci tanpa
        izin tulis sesi menerima tautan sesi dan token sebagai null. Lihat
        https://docs.didit.me/console/api-keys.

````

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