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

> PATCH /v3/lists/{list_uuid}/ — rename or update the description of a Didit allowlist or custom list. System blocklists are immutable.

export const AgentPromptAccordion = ({prompt, title = "AI Agent Integration Prompt"}) => {
  const [copied, setCopied] = React.useState(false);
  const handleCopy = e => {
    e.stopPropagation();
    if (!prompt) return;
    navigator.clipboard.writeText(prompt.trim()).then(() => {
      setCopied(true);
      setTimeout(() => setCopied(false), 2000);
    });
  };
  const agents = ["Claude Code", "Codex", "Cursor", "Devin", "Windsurf", "GitHub Copilot"];
  return <div className="didit-agent-card">
      {}
      <div className="didit-agent-titlebar">
        <div className="didit-agent-dots" aria-hidden="true">
          <span className="didit-agent-dot didit-agent-dot-red"></span>
          <span className="didit-agent-dot didit-agent-dot-yellow"></span>
          <span className="didit-agent-dot didit-agent-dot-green"></span>
        </div>
        <span className="didit-agent-filename">{title}</span>
        <button type="button" className={`didit-agent-copy ${copied ? "didit-agent-copy-copied" : ""}`} onClick={handleCopy} title="Copy prompt to clipboard" aria-label={copied ? "Copied!" : "Copy prompt to clipboard"}>
          {copied ? <>
              <svg width="13" height="13" viewBox="0 0 16 16" fill="none">
                <path d="M3 8.5l3.5 3.5L13 4" stroke="currentColor" strokeWidth="2" strokeLinecap="round" strokeLinejoin="round" />
              </svg>
              <span>Copied</span>
            </> : <>
              <svg width="13" height="13" viewBox="0 0 16 16" fill="none">
                <rect x="5" y="5" width="9" height="9" rx="1.5" stroke="currentColor" strokeWidth="1.5" />
                <path d="M11 5V3.5A1.5 1.5 0 0 0 9.5 2h-6A1.5 1.5 0 0 0 2 3.5v6A1.5 1.5 0 0 0 3.5 11H5" stroke="currentColor" strokeWidth="1.5" />
              </svg>
              <span>Copy</span>
            </>}
        </button>
      </div>

      {}
      <pre className="didit-agent-body"><code>{prompt.trim()}</code></pre>

      {}
      <div className="didit-agent-footer">
        <span className="didit-agent-footer-label">Paste into</span>
        <div className="didit-agent-chips">
          {agents.map(name => <span key={name} className="didit-agent-chip">{name}</span>)}
        </div>
      </div>
    </div>;
};

<AgentPromptAccordion
  title="Update List API Prompt"
  prompt={`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.

Goal:
- Update the editable metadata of an allowlist or custom list. list_type and entry_type are immutable — if you need to change those, delete and recreate the list.
- System blocklists are immutable; PATCH on a system list returns 403/400.

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

Request body (application/json):
{
"name": "Updated List Name",
"description": "Optional new description"
}

Either field is optional, but at least one should be provided. name must remain unique per application.

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": "Updated List Name"}'

Failure modes:
- 400 — attempt to update list_type, entry_type, or is_system (immutable).
- 401 — missing or malformed x-api-key.
- 403 — canonical { "detail": "You do not have permission to perform this action." } envelope, also returned when patching a system blocklist.
- 404 — list not found in this application.
- 409 — name collides with another list in this application.

Side effects:
- name/description changes are immediately visible in the console and on subsequent GET calls.

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

Update the name or description of a list. System lists cannot be modified.

## Request body

| Field         | Type   | Description                               |
| ------------- | ------ | ----------------------------------------- |
| `name`        | string | New name (must be unique per application) |
| `description` | string | New description                           |

<RequestExample>
  ```bash theme={null}
  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": "Updated List Name"}'
  ```
</RequestExample>
