{ "data": { "id": "3f2a1b0c-9d8e-4f7a-8b6c-5d4e3f2a1b0c", "tenant_id": "123e4567-e89b-12d3-a456-426614174000", "name": "Offboarded clients", "description": "Clients we no longer do business with, reviewed quarterly", "status": "active", "schema_version": 1, "record_id_column": "record_uid", "default_feed_category": "internal", "risk_score_impact": 50, "created_by": "64b1c0de00000000000000a1", "created_at": "2026-11-05T01:20:05.346Z", "updated_at": "2026-11-05T02:04:11.902Z" }}
name is required.
Missing Authorization: Api-Key or x-api-key header.
Custom list management is not enabled.
{
"error": "conflict",
"message": "Another change to your organization's custom lists is in progress; retry.",
"retryable": true
}
Authentication service is unavailable.
Custom Lists
Update a custom list
Updates list settings. Changes are part of the working set and are applied by the next publish. Requires an admin API key, the Admin (tenant-wide) key type, which only an owner or admin of this organization can create. Workspace scoped and Tenant scoped keys are refused with 403. The x-user-token scheme is the Minerva dashboard session token; with it, writes require an owner or admin.
PATCH
/
custom-lists
/
v2
/
organizations
/
{orgId}
/
{listId}
Update a custom list
curl --request PATCH \ --url https://api.gominerva.com/custom-lists/v2/organizations/{orgId}/{listId} \ --header 'Authorization: <api-key>' \ --header 'Content-Type: application/json' \ --data '{ "description": "Clients we no longer do business with, reviewed quarterly", "risk_score_impact": 50}'
import requests
url = "https://api.gominerva.com/custom-lists/v2/organizations/{orgId}/{listId}"
payload = {
"description": "Clients we no longer do business with, reviewed quarterly",
"risk_score_impact": 50
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: 'Clients we no longer do business with, reviewed quarterly',
risk_score_impact: 50
})
};
fetch('https://api.gominerva.com/custom-lists/v2/organizations/{orgId}/{listId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
An admin application key: Authorization: Api-Key <token> (or legacy x-api-key). Only tenant owners and admins can create one. Standard keys are refused with 403 on workspace management and tenant configuration routes.
{"docsConfig":{"theme":"mint","$schema":"https://hub.gominerva.com/docs.json","name":"Minerva Docs","colors":{"primary":"#4e26b1","light":"#beb7fb","dark":"#271362"},"logo":{"light":"https://mintcdn.com/minerva-557aeab7/42KvxtYHwgz1q8RK/logo/minerva-dark.svg?fit=max\u0026auto=format\u0026n=42KvxtYHwgz1q8RK\u0026q=85\u0026s=b6ef1ed1a0b7ff7df81fdbb1c2ac0db4","dark":"https://mintcdn.com/minerva-557aeab7/42KvxtYHwgz1q8RK/logo/minerva-light.svg?fit=max\u0026auto=format\u0026n=42KvxtYHwgz1q8RK\u0026q=85\u0026s=986049de4dbc27a2e833d88aaff85c3c"},"favicon":"https://mintcdn.com/minerva-557aeab7/42KvxtYHwgz1q8RK/favicon.svg?fit=max\u0026auto=format\u0026n=42KvxtYHwgz1q8RK\u0026q=85\u0026s=313cf5bf970aa85c301aadfb9dda68b2","navbar":{"primary":{"type":"button","label":"Go to Minerva App","href":"https://app.gominerva.com"}},"footer":{"socials":{"linkedin":"https://linkedin.com/company/gominerva"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Support","icon":"headset","href":"mailto:support@gominerva.com"},{"anchor":"Trust Page","icon":"shield","href":"https://app.conveyor.com/profile/gominerva"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"minerva-557aeab7","hasAudioNarration":false,"actualSubdomain":"minerva-557aeab7","customDomains":["docs.gominerva.com"],"gitSource":{"type":"gitlab","owner":"minervaai/interfaces","repo":"minerva-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"projectId":74271980,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af3e28bde222de6f181f6bc","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"default","tag":"API Reference","count":184},{"language":"default","tag":"Admin Actions - Endpoints","count":64},{"language":"default","tag":"Agent Risk Assessments - Endpoints","count":44},{"language":"default","tag":"Identity Verification - Endpoints","count":42},{"language":"default","tag":"Knowledge Hub","count":32},{"language":"default","tag":"Custom Lists","count":29},{"language":"default","tag":"User Guides","count":19},{"language":"default","tag":"Agent Runtime","count":14},{"language":"default","tag":"Themes","count":14},{"language":"default","tag":"API Documentation","count":13}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/custom-lists/update-a-custom-list","slug":"/api-reference/custom-lists/update-a-custom-list","pageMetadata":{"title":"Update a custom list","description":"Updates list settings. Changes are part of the working set and are applied by the next publish. Requires an admin API key, the **Admin (tenant-wide)** key type, which only an owner or admin of this organization can create. **Workspace scoped** and **Tenant scoped** keys are refused with 403. The `x-user-token` scheme is the Minerva dashboard session token; with it, writes require an owner or admin.","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json patch /custom-lists/v2/organizations/{orgId}/{listId}","href":"/api-reference/custom-lists/update-a-custom-list","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Updates list settings. Changes are part of the working set and are applied by the next publish. Requires an admin API key, the \", _jsx(_components.strong, {\n children: \"Admin (tenant-wide)\"\n }), \" key type, which only an owner or admin of this organization can create. \", _jsx(_components.strong, {\n children: \"Workspace scoped\"\n }), \" and \", _jsx(_components.strong, {\n children: \"Tenant scoped\"\n }), \" keys are refused with 403. The \", _jsx(_components.code, {\n children: \"x-user-token\"\n }), \" scheme is the Minerva dashboard session token; with it, writes require an owner or admin.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Update a custom list","description":"Updates list settings. Changes are part of the working set and are applied by the next publish. Requires an admin API key, the **Admin (tenant-wide)** key type, which only an owner or admin of this organization can create. **Workspace scoped** and **Tenant scoped** keys are refused with 403. The `x-user-token` scheme is the Minerva dashboard session token; with it, writes require an owner or admin.","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json patch /custom-lists/v2/organizations/{orgId}/{listId}","href":"/api-reference/custom-lists/update-a-custom-list","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Custom Lists"],"summary":"Update a custom list","description":"Updates list settings. Changes are part of the working set and are applied by the next publish. Requires an admin API key, the **Admin (tenant-wide)** key type, which only an owner or admin of this organization can create. **Workspace scoped** and **Tenant scoped** keys are refused with 403. The `x-user-token` scheme is the Minerva dashboard session token; with it, writes require an owner or admin.","security":["e2b1cf19-f8ae-4983-b49f-11399b72daa3","901f84db-ed1d-4e3b-bcd6-081fac071dca"],"parameters":["0ff4ce06-b9fc-49b6-ad82-f00e2e64e43e","6950d705-0c0b-4849-a6b0-dedc5de8ba4c"],"requestBody":"7310fb54-ffb5-4c70-92fa-41e125d5e36e","responses":{"200":"d549b445-9863-4055-a123-af5225ef08f3","400":"ae34e265-4dc6-49c3-966a-81adb180303b","403":"29dde251-ee40-4352-8a8c-ab6a0b7922a1","404":"8330f263-d1c8-4c6e-b235-f1fcf9d02fa1","409":"5c4c6447-2a82-440a-bb4e-b27b39ffb4fa","503":"439748e1-3e06-432f-b1bf-36c20512b04d"},"method":"patch","type":"path","servers":["9984538b-a839-4fd3-a8b0-b20e317e908f"],"path":"/custom-lists/v2/organizations/{orgId}/{listId}","baseUrlOptions":["https://api.gominerva.com"],"title":"Update a custom list","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"0ff4ce06-b9fc-49b6-ad82-f00e2e64e43e":{"in":"path","name":"orgId","required":true,"schema":{"type":"string","isRequired":true,"description":"The organization (tenant) id. Must equal the tenant of the admin key.","uniqueKey":"","typeLabel":"string"},"description":"The organization (tenant) id. Must equal the tenant of the admin key."},"6950d705-0c0b-4849-a6b0-dedc5de8ba4c":{"in":"path","name":"listId","required":true,"schema":{"type":"string","isRequired":true,"description":"The custom list id.","uniqueKey":"","typeLabel":"string"},"description":"The custom list id."}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Omitted fields are left unchanged.","properties":{"name":{"type":"string","uniqueKey":"name","typeLabel":"string"},"description":{"type":"string","uniqueKey":"description","typeLabel":"string"},"default_feed_category":{"type":"string","enum":["internal","sanctions","pep","news","legal","criminal"],"uniqueKey":"default_feed_category","typeLabel":"enum\u003cstring>"},"risk_score_impact":{"type":"integer","minimum":0,"maximum":100,"uniqueKey":"risk_score_impact","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"object"},"examples":{"update":{"title":"update","value":{"description":"Clients we no longer do business with, reviewed quarterly","risk_score_impact":50}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"d549b445-9863-4055-a123-af5225ef08f3":{"description":"Success","content":{"application/json":{"schema":{"type":"object","description":"`{ data: CustomList }`","properties":{"data":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.id","typeLabel":"string"},"tenant_id":{"type":"string","isRequired":true,"uniqueKey":"data.tenant_id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"data.name","typeLabel":"string"},"description":{"type":"string","isRequired":true,"uniqueKey":"data.description","typeLabel":"string"},"status":{"type":"string","enum":["active","archived"],"isRequired":true,"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"schema_version":{"type":"integer","isRequired":true,"uniqueKey":"data.schema_version","typeLabel":"integer"},"record_id_column":{"type":"string","isRequired":true,"uniqueKey":"data.record_id_column","typeLabel":"string"},"default_feed_category":{"type":"string","enum":["internal","sanctions","pep","news","legal","criminal"],"isRequired":true,"uniqueKey":"data.default_feed_category","typeLabel":"enum\u003cstring>"},"risk_score_impact":{"type":"integer","minimum":0,"maximum":100,"description":"How much a match against this list raises the Client Risk Rating (CRR): 0 = no effect, 100 = rates the client High immediately.","isRequired":true,"uniqueKey":"data.risk_score_impact","typeLabel":"integer"},"created_by":{"type":"string","description":"The actor that created the list: a user id, or the admin application id for a key request.","isRequired":true,"uniqueKey":"data.created_by","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.updated_at","typeLabel":"string\u003cdate-time>"}},"required":["id","tenant_id","name","description","status","schema_version","record_id_column","default_feed_category","risk_score_impact","created_by","created_at","updated_at"],"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["data"],"uniqueKey":"","typeLabel":"object"},"examples":{"updated":{"title":"updated","value":{"data":{"id":"3f2a1b0c-9d8e-4f7a-8b6c-5d4e3f2a1b0c","tenant_id":"123e4567-e89b-12d3-a456-426614174000","name":"Offboarded clients","description":"Clients we no longer do business with, reviewed quarterly","status":"active","schema_version":1,"record_id_column":"record_uid","default_feed_category":"internal","risk_score_impact":50,"created_by":"64b1c0de00000000000000a1","created_at":"2026-11-05T01:20:05.346Z","updated_at":"2026-11-05T02:04:11.902Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"ae34e265-4dc6-49c3-966a-81adb180303b":{"description":"Invalid request: a required field is missing or a value is invalid. Some validation errors (for example `name is required.`) are plain text; others (`error` is `validation_failed`) are a JSON `CustomListError`. Branch on `Content-Type`.","content":{"text/plain":{"schema":{"type":"string","example":"name is required.","uniqueKey":"","typeLabel":"string"},"examples":{"Example":{"title":"Example","value":"name is required."}},"exampleType":"generated"},"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Machine-readable code, e.g. `validation_failed`, `limit_exceeded`, `conflict`, `not_enabled`, `upload_capacity_exceeded`, `upload_request_timeout`.","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"limit":{"type":"string","description":"For `limit_exceeded`: the entitlement limit, e.g. `maxRecordsPerList`.","uniqueKey":"limit","typeLabel":"string"},"max":{"type":"integer","description":"For `limit_exceeded`: the configured maximum.","uniqueKey":"max","typeLabel":"integer"},"retryable":{"type":"boolean","uniqueKey":"retryable","typeLabel":"boolean"}},"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"validation":{"title":"validation","value":{"error":"validation_failed","message":"custom-list: validation failed: name is required"}}},"exampleType":"examples"}},"exampleType":"examples"},"29dde251-ee40-4352-8a8c-ab6a0b7922a1":{"description":"No credentials were sent; the API key was revoked, has expired, or its application is deactivated (`API-key authentication was denied.`); the key is not an admin application key (**Workspace scoped** and **Tenant scoped** keys are refused); it belongs to another organization; or its creator is no longer an owner or admin. For a user token, the user is not a member, or is not an owner or admin on a write.","content":{"text/plain":{"schema":{"type":"string","example":"Missing Authorization: Api-Key or x-api-key header.","uniqueKey":"","typeLabel":"string"},"examples":{"Example":{"title":"Example","value":"Missing Authorization: Api-Key or x-api-key header."}},"exampleType":"generated"}},"exampleType":"generated"},"8330f263-d1c8-4c6e-b235-f1fcf9d02fa1":{"description":"Custom list management is not enabled (`Custom list management is not enabled.`); the list, record, upload, job or workspace is not in this organization; or the application API key (`mrva-…`) is unknown (`API-key authentication was denied.`).","content":{"text/plain":{"schema":{"type":"string","example":"Custom list management is not enabled.","uniqueKey":"","typeLabel":"string"},"examples":{"Example":{"title":"Example","value":"Custom list management is not enabled."}},"exampleType":"generated"}},"exampleType":"generated"},"5c4c6447-2a82-440a-bb4e-b27b39ffb4fa":{"description":"Another change to your organization's custom lists is in progress; retry. JSON `CustomListError` with `error: conflict`.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Machine-readable code, e.g. `validation_failed`, `limit_exceeded`, `conflict`, `not_enabled`, `upload_capacity_exceeded`, `upload_request_timeout`.","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"limit":{"type":"string","description":"For `limit_exceeded`: the entitlement limit, e.g. `maxRecordsPerList`.","uniqueKey":"limit","typeLabel":"string"},"max":{"type":"integer","description":"For `limit_exceeded`: the configured maximum.","uniqueKey":"max","typeLabel":"integer"},"retryable":{"type":"boolean","uniqueKey":"retryable","typeLabel":"boolean"}},"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"conflict":{"title":"conflict","value":{"error":"conflict","message":"Another change to your organization's custom lists is in progress; retry.","retryable":true}}},"exampleType":"examples"}},"exampleType":"examples"},"439748e1-3e06-432f-b1bf-36c20512b04d":{"description":"The authentication service is temporarily unavailable (`Authentication service is unavailable.`). Nothing was changed; retry with backoff.","content":{"text/plain":{"schema":{"type":"string","example":"Authentication service is unavailable.","uniqueKey":"","typeLabel":"string"},"examples":{"Example":{"title":"Example","value":"Authentication service is unavailable."}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"e2b1cf19-f8ae-4983-b49f-11399b72daa3":{"AdminApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"An admin application key: `Authorization: Api-Key \u003ctoken>` (or legacy `x-api-key`). Only tenant owners and admins can create one. Standard keys are refused with 403 on workspace management and tenant configuration routes.","scopes":[],"schemeName":"AdminApiKeyAuth"}},"901f84db-ed1d-4e3b-bcd6-081fac071dca":{"UserTokenAuth":{"type":"apiKey","in":"header","name":"x-user-token","description":"Firebase user token for authentication","scopes":[],"schemeName":"UserTokenAuth"}}},"servers":{"9984538b-a839-4fd3-a8b0-b20e317e908f":{"url":"https://api.gominerva.com","description":"The production API server for Minerva."}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"Authorization","description":"An admin application key: `Authorization: Api-Key \u003ctoken>` (or legacy `x-api-key`). Only tenant owners and admins can create one. Standard keys are refused with 403 on workspace management and tenant configuration routes.","scopes":[],"schemeName":"AdminApiKeyAuth"},"schema":{"title":"Authorization","type":"string","description":"An admin application key: `Authorization: Api-Key \u003ctoken>` (or legacy `x-api-key`). Only tenant owners and admins can create one. Standard keys are refused with 403 on workspace management and tenant configuration routes.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"AdminApiKeyAuth","name":"Authorization"}],"title":"AdminApiKeyAuth"},{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-user-token","description":"Firebase user token for authentication","scopes":[],"schemeName":"UserTokenAuth"},"schema":{"title":"x-user-token","type":"string","description":"Firebase user token for authentication","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"UserTokenAuth","name":"x-user-token"}],"title":"UserTokenAuth"}]},"originalFileLocation":"api-reference/admin-api.json"},"subdomain":"minerva-557aeab7","siteName":"Minerva Docs","title":"Update a custom list - Minerva Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-08T02:03:51.825Z","originalFileLocation":"api-reference/custom-lists/update-a-custom-list.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Updates list settings. Changes are part of the working set and are applied by the next publish. Requires an admin API key, the Admin (tenant-wide) key type, which only an owner or admin of this organization can create. Workspace scoped and Tenant scoped keys are refused with 403. The x-user-token scheme is the Minerva dashboard session token; with it, writes require an owner or admin.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Minerva Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/minerva-557aeab7/wxw0aTOZ3vYCYbpb/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/minerva-557aeab7/wxw0aTOZ3vYCYbpb/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/minerva-557aeab7/wxw0aTOZ3vYCYbpb/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/minerva-557aeab7/wxw0aTOZ3vYCYbpb/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/minerva-557aeab7/wxw0aTOZ3vYCYbpb/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/minerva-557aeab7/wxw0aTOZ3vYCYbpb/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/minerva-557aeab7/wxw0aTOZ3vYCYbpb/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/minerva-557aeab7/wxw0aTOZ3vYCYbpb/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/minerva-557aeab7/wxw0aTOZ3vYCYbpb/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update a custom list - Minerva Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Updates list settings. Changes are part of the working set and are applied by the next publish. Requires an admin API key, the Admin (tenant-wide) key type, which only an owner or admin of this organization can create. Workspace scoped and Tenant scoped keys are refused with 403. The x-user-token scheme is the Minerva dashboard session token; with it, writes require an owner or admin.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Minerva Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.gominerva.com/api-reference/custom-lists/update-a-custom-list\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://minerva-557aeab7.mintlify.site/_mintlify/api/og/v2?division=Custom+Lists\u0026amp;title=Update+a+custom+list\u0026amp;description=Updates+list+settings.+Changes+are+part+of+the+working+set+and+are+applied+by+the+next+publish.+Requires+an+admin+API+key%2C+the+**Admin+%28tenant-wide%29**+key+type%2C\u0026amp;theme=802683985af28e0bed63a6bd\u0026amp;signature=e692e12c62822772ce679675c63ca82f04352d7c7d0f23771160b202029663c9\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Update a custom list - Minerva Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Updates list settings. Changes are part of the working set and are applied by the next publish. Requires an admin API key, the Admin (tenant-wide) key type, which only an owner or admin of this organization can create. Workspace scoped and Tenant scoped keys are refused with 403. The x-user-token scheme is the Minerva dashboard session token; with it, writes require an owner or admin.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://minerva-557aeab7.mintlify.site/_mintlify/api/og/v2?division=Custom+Lists\u0026amp;title=Update+a+custom+list\u0026amp;description=Updates+list+settings.+Changes+are+part+of+the+working+set+and+are+applied+by+the+next+publish.+Requires+an+admin+API+key%2C+the+**Admin+%28tenant-wide%29**+key+type%2C\u0026amp;theme=802683985af28e0bed63a6bd\u0026amp;signature=e692e12c62822772ce679675c63ca82f04352d7c7d0f23771160b202029663c9\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/minerva-557aeab7/wxw0aTOZ3vYCYbpb/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Minerva Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4e26b1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.gominerva.com/api-reference/custom-lists/update-a-custom-list\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/custom-lists/update-a-custom-list.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.gominerva.com/#organization\",\"name\":\"Minerva Docs\",\"url\":\"https://docs.gominerva.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/minerva-557aeab7/42KvxtYHwgz1q8RK/logo/minerva-dark.svg?fit=max\u0026auto=format\u0026n=42KvxtYHwgz1q8RK\u0026q=85\u0026s=b6ef1ed1a0b7ff7df81fdbb1c2ac0db4\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.gominerva.com#website\",\"name\":\"Minerva Docs\",\"url\":\"https://docs.gominerva.com\",\"publisher\":{\"@id\":\"https://docs.gominerva.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.gominerva.com/api-reference/custom-lists/update-a-custom-list#webpage\",\"url\":\"https://docs.gominerva.com/api-reference/custom-lists/update-a-custom-list\",\"name\":\"Update a custom list\",\"description\":\"Updates list settings. Changes are part of the working set and are applied by the next publish. Requires an admin API key, the Admin (tenant-wide) key type, which only an owner or admin of this organization can create. Workspace scoped and Tenant scoped keys are refused with 403. The x-user-token scheme is the Minerva dashboard session token; with it, writes require an owner or admin.\",\"dateModified\":\"2026-11-08T02:03:51.825Z\",\"isPartOf\":{\"@id\":\"https://docs.gominerva.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.gominerva.com/api-reference/custom-lists/update-a-custom-list#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.gominerva.com/api-reference/custom-lists/update-a-custom-list#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Admin Actions - Endpoints\",\"item\":\"https://docs.gominerva.com/api-reference/screening-webhooks/get-screening-webhook\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Custom Lists\",\"item\":\"https://docs.gominerva.com/api-reference/custom-lists/get-custom-list-entitlements\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Update a custom list\",\"item\":\"https://docs.gominerva.com/api-reference/custom-lists/update-a-custom-list\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.gominerva.com/api-reference/custom-lists/update-a-custom-list#apireference\",\"headline\":\"Update a custom list\",\"name\":\"Update a custom list\",\"description\":\"Updates list settings. Changes are part of the working set and are applied by the next publish. Requires an admin API key, the Admin (tenant-wide) key type, which only an owner or admin of this organization can create. Workspace scoped and Tenant scoped keys are refused with 403. The x-user-token scheme is the Minerva dashboard session token; with it, writes require an owner or admin.\",\"url\":\"https://docs.gominerva.com/api-reference/custom-lists/update-a-custom-list\",\"mainEntityOfPage\":{\"@id\":\"https://docs.gominerva.com/api-reference/custom-lists/update-a-custom-list#webpage\"},\"dateModified\":\"2026-11-08T02:03:51.825Z\",\"publisher\":{\"@id\":\"https://docs.gominerva.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.gominerva.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Minerva Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Minerva Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/custom-lists/update-a-custom-list.md","siteName":"Minerva Docs","nav":{"global":{"anchors":[{"anchor":"Support","icon":"headset","href":"mailto:support@gominerva.com"},{"anchor":"Trust Page","icon":"shield","href":"https://app.conveyor.com/profile/gominerva"}]},"tabs":[{"tab":"Knowledge Hub","pages":[{"title":"Knowledge Hub","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Screening Integration Guide","href":"/api-reference/screening-integration-guide"},{"title":"IDV Integration Guide","href":"/api-reference/idv-integration-guide"},{"title":"Automatic Disposition Guide","tag":"New","href":"/api-reference/automatic-disposition-guide"},{"title":"API Keys","mode":"wide","href":"/api-reference/api-keys"},{"title":"Workspace management \u0026 tenant configuration via API","sidebarTitle":"Workspace Management API","href":"/api-reference/workspace-management-api"},{"title":"Automate custom lists via API","sidebarTitle":"Custom Lists API","href":"/api-reference/custom-lists-api"},{"title":"Webhooks","href":"/api-reference/webhooks"},{"title":"Minerva MCP","mode":"wide","href":"/api-reference/minerva-mcp-guide"},{"title":"Search History","href":"/api-reference/search-history"},{"title":"Profile Groups API","href":"/api-reference/profile-groups"},{"title":"Profile Custom Fields API","href":"/api-reference/profile-custom-fields"},{"title":"Risk Assessment Agents API","tag":"New","href":"/api-reference/risk-assessment-agents"}]},{"group":"Screening - Endpoints","pages":[{"group":"Search","pages":[{"title":"Submit a batch search","deprecated":null,"version":null,"openapi":"/api-reference/core.json post /v1/search","href":"/api-reference/search/submit-a-batch-search"},{"title":"Get batch search results","deprecated":null,"version":null,"openapi":"/api-reference/core.json get /v1/search/{jobid}","href":"/api-reference/search/get-batch-search-results"},{"title":"Search one person or organization","deprecated":null,"version":null,"openapi":"/api-reference/core.json post /v1/search-sync","href":"/api-reference/search/search-one-person-or-organization"},{"title":"Submit a v2 search","deprecated":null,"version":null,"openapi":"/api-reference/core.json post /v2/search","href":"/api-reference/search/submit-a-v2-search"},{"title":"List search request history","deprecated":null,"version":null,"openapi":"/api-reference/core.json get /v2/search/requests","href":"/api-reference/search/list-search-request-history"},{"title":"Generate a PDF report","deprecated":null,"version":null,"openapi":"/api-reference/core.json post /v1/reports","href":"/api-reference/search/generate-a-pdf-report"}]},{"group":"Legacy","pages":[{"title":"Search one person or organization (legacy GET)","deprecated":true,"version":null,"openapi":"/api-reference/core.json get /v1/search-sync","href":"/api-reference/legacy/search-one-person-or-organization-legacy-get"}]},{"group":"API to UI Integration","pages":[{"title":"Send an API result to a user","deprecated":null,"version":null,"openapi":"/api-reference/core.json post /v1/sendAPIResultToUser","href":"/api-reference/api-to-ui-integration/send-an-api-result-to-a-user"}]}]},{"group":"Admin Actions - Endpoints","pages":[{"group":"Screening Webhooks","pages":[{"title":"Get screening webhook","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /webhooks/v2/screening/{webhookId}","href":"/api-reference/screening-webhooks/get-screening-webhook"},{"title":"Delete screening webhook","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json delete /webhooks/v2/screening/{webhookId}","href":"/api-reference/screening-webhooks/delete-screening-webhook"},{"title":"Update screening webhook","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json patch /webhooks/v2/screening/{webhookId}","href":"/api-reference/screening-webhooks/update-screening-webhook"},{"title":"Test screening webhook","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json post /webhooks/v2/screening/{webhookId}/test","href":"/api-reference/screening-webhooks/test-screening-webhook"},{"title":"List screening webhooks","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /webhooks/v2/screening","href":"/api-reference/screening-webhooks/list-screening-webhooks"},{"title":"Create screening webhook","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json post /webhooks/v2/screening","href":"/api-reference/screening-webhooks/create-screening-webhook"}]},{"group":"Custom Lists","pages":[{"title":"Get custom-list entitlements","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /custom-lists/v2/organizations/{orgId}/entitlements","href":"/api-reference/custom-lists/get-custom-list-entitlements"},{"title":"Get a workspace custom-list manifest","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /custom-lists/v2/organizations/{orgId}/workspaces/{workspaceId}/manifest","href":"/api-reference/custom-lists/get-a-workspace-custom-list-manifest"},{"title":"Activate or deactivate a list in a workspace","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json put /custom-lists/v2/organizations/{orgId}/workspaces/{workspaceId}/lists/{listId}/activation","href":"/api-reference/custom-lists/activate-or-deactivate-a-list-in-a-workspace"},{"title":"List custom lists","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /custom-lists/v2/organizations/{orgId}","href":"/api-reference/custom-lists/list-custom-lists"},{"title":"Create a custom list","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json post /custom-lists/v2/organizations/{orgId}","href":"/api-reference/custom-lists/create-a-custom-list"},{"title":"Download the generic upload template","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /custom-lists/v2/organizations/{orgId}/upload-template","href":"/api-reference/custom-lists/download-the-generic-upload-template"},{"title":"Get a custom-list background job","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /custom-lists/v2/organizations/{orgId}/jobs/{jobId}","href":"/api-reference/custom-lists/get-a-custom-list-background-job"},{"title":"Get a custom list","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /custom-lists/v2/organizations/{orgId}/{listId}","href":"/api-reference/custom-lists/get-a-custom-list"},{"title":"Archive a custom list","description":"Archives a custom list and deactivates it in every workspace. Requires an admin API key, the **Admin (tenant-wide)** key type, which only an owner or admin of this organization can create. **Workspace scoped** and **Tenant scoped** keys are refused with 403. The `x-user-token` scheme is the Minerva dashboard session token; with it, writes require an owner or admin.","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json delete /custom-lists/v2/organizations/{orgId}/{listId}","href":"/api-reference/custom-lists/archive-a-custom-list"},{"title":"Update a custom list","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json patch /custom-lists/v2/organizations/{orgId}/{listId}","href":"/api-reference/custom-lists/update-a-custom-list"},{"title":"Get list deployment status","description":"Reads the deployment status of the list's latest version (`pending`, `live` or `down`) and, with `workspace_id`, its activation in that workspace. Poll this after a publish until `deployment_status` is `live`. Requires an admin API key, the **Admin (tenant-wide)** key type, which only an owner or admin of this organization can create. **Workspace scoped** and **Tenant scoped** keys are refused with 403. The `x-user-token` scheme is the Minerva dashboard session token; with it, writes require an owner or admin.","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /custom-lists/v2/organizations/{orgId}/{listId}/status","href":"/api-reference/custom-lists/get-list-deployment-status"},{"title":"Get unpublished changes","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /custom-lists/v2/organizations/{orgId}/{listId}/pending-changes","href":"/api-reference/custom-lists/get-unpublished-changes"},{"title":"Publish the working set","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json post /custom-lists/v2/organizations/{orgId}/{listId}/publish","href":"/api-reference/custom-lists/publish-the-working-set"},{"title":"Discard unpublished changes","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json post /custom-lists/v2/organizations/{orgId}/{listId}/discard","href":"/api-reference/custom-lists/discard-unpublished-changes"},{"title":"List published versions","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /custom-lists/v2/organizations/{orgId}/{listId}/versions","href":"/api-reference/custom-lists/list-published-versions"},{"title":"List records","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /custom-lists/v2/organizations/{orgId}/{listId}/records","href":"/api-reference/custom-lists/list-records"},{"title":"Add a record","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json post /custom-lists/v2/organizations/{orgId}/{listId}/records","href":"/api-reference/custom-lists/add-a-record"},{"title":"Archive a record","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json delete /custom-lists/v2/organizations/{orgId}/{listId}/records/{recordId}","href":"/api-reference/custom-lists/archive-a-record"},{"title":"Update a record","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json patch /custom-lists/v2/organizations/{orgId}/{listId}/records/{recordId}","href":"/api-reference/custom-lists/update-a-record"},{"title":"Set a record's status","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json put /custom-lists/v2/organizations/{orgId}/{listId}/records/{recordId}/status","href":"/api-reference/custom-lists/set-a-records-status"},{"title":"List uploads","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /custom-lists/v2/organizations/{orgId}/{listId}/uploads","href":"/api-reference/custom-lists/list-uploads"},{"title":"Upload parsed records","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json post /custom-lists/v2/organizations/{orgId}/{listId}/uploads","href":"/api-reference/custom-lists/upload-parsed-records"},{"title":"Upload a file","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json post /custom-lists/v2/organizations/{orgId}/{listId}/uploads/file","href":"/api-reference/custom-lists/upload-a-file"},{"title":"Preview parsed records","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json post /custom-lists/v2/organizations/{orgId}/{listId}/uploads/preview","href":"/api-reference/custom-lists/preview-parsed-records"},{"title":"Preview a file","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json post /custom-lists/v2/organizations/{orgId}/{listId}/uploads/preview/file","href":"/api-reference/custom-lists/preview-a-file"},{"title":"Download the list's upload template","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /custom-lists/v2/organizations/{orgId}/{listId}/uploads/template","href":"/api-reference/custom-lists/download-the-lists-upload-template"},{"title":"Get an upload","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /custom-lists/v2/organizations/{orgId}/{listId}/uploads/{uploadId}","href":"/api-reference/custom-lists/get-an-upload"},{"title":"Get upload status","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /custom-lists/v2/organizations/{orgId}/{listId}/uploads/{uploadId}/status","href":"/api-reference/custom-lists/get-upload-status"},{"title":"Publish an upload","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json post /custom-lists/v2/organizations/{orgId}/{listId}/uploads/{uploadId}/publish","href":"/api-reference/custom-lists/publish-an-upload"}]},{"group":"CRR Scorecards","pages":[{"title":"List CRR scorecards","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /workspaces/v2/organizations/{orgId}/{workspaceId}/crr-scorecards","href":"/api-reference/crr-scorecards/list-crr-scorecards"},{"title":"Create a CRR scorecard","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json post /workspaces/v2/organizations/{orgId}/{workspaceId}/crr-scorecards","href":"/api-reference/crr-scorecards/create-a-crr-scorecard"},{"title":"List scorecard revisions","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /workspaces/v2/organizations/{orgId}/{workspaceId}/crr-scorecards/{scorecardId}/revisions","href":"/api-reference/crr-scorecards/list-scorecard-revisions"},{"title":"Get a CRR scorecard","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /workspaces/v2/organizations/{orgId}/{workspaceId}/crr-scorecards/{scorecardId}","href":"/api-reference/crr-scorecards/get-a-crr-scorecard"},{"title":"Archive a CRR scorecard","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json delete /workspaces/v2/organizations/{orgId}/{workspaceId}/crr-scorecards/{scorecardId}","href":"/api-reference/crr-scorecards/archive-a-crr-scorecard"},{"title":"Update a CRR scorecard","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json patch /workspaces/v2/organizations/{orgId}/{workspaceId}/crr-scorecards/{scorecardId}","href":"/api-reference/crr-scorecards/update-a-crr-scorecard"},{"title":"Set the default scorecard","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json post /workspaces/v2/organizations/{orgId}/{workspaceId}/crr-scorecards/{scorecardId}/default","href":"/api-reference/crr-scorecards/set-the-default-scorecard"}]},{"group":"CRR Profile Templates","pages":[{"title":"List CRR profile templates","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /workspaces/v2/organizations/{orgId}/{workspaceId}/crr-templates","href":"/api-reference/crr-profile-templates/list-crr-profile-templates"},{"title":"Create a CRR profile template","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json post /workspaces/v2/organizations/{orgId}/{workspaceId}/crr-templates","href":"/api-reference/crr-profile-templates/create-a-crr-profile-template"},{"title":"List selectable templates","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /workspaces/v2/organizations/{orgId}/{workspaceId}/crr-templates/selectable","href":"/api-reference/crr-profile-templates/list-selectable-templates"},{"title":"Get a CRR profile template","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /workspaces/v2/organizations/{orgId}/{workspaceId}/crr-templates/{templateId}","href":"/api-reference/crr-profile-templates/get-a-crr-profile-template"},{"title":"Update a CRR profile template","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json patch /workspaces/v2/organizations/{orgId}/{workspaceId}/crr-templates/{templateId}","href":"/api-reference/crr-profile-templates/update-a-crr-profile-template"},{"title":"Activate a template","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json post /workspaces/v2/organizations/{orgId}/{workspaceId}/crr-templates/{templateId}/activate","href":"/api-reference/crr-profile-templates/activate-a-template"},{"title":"Archive a template","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json post /workspaces/v2/organizations/{orgId}/{workspaceId}/crr-templates/{templateId}/archive","href":"/api-reference/crr-profile-templates/archive-a-template"},{"title":"List template revisions","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /workspaces/v2/organizations/{orgId}/{workspaceId}/crr-templates/{templateId}/revisions","href":"/api-reference/crr-profile-templates/list-template-revisions"}]},{"group":"Workspaces","pages":[{"title":"Get a workspace","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /workspaces/v2/organizations/{orgId}/{workspaceId}","href":"/api-reference/workspaces/get-a-workspace"},{"title":"Delete a workspace","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json delete /workspaces/v2/organizations/{orgId}/{workspaceId}","href":"/api-reference/workspaces/delete-a-workspace"},{"title":"Update a workspace","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json patch /workspaces/v2/organizations/{orgId}/{workspaceId}","href":"/api-reference/workspaces/update-a-workspace"},{"title":"List workspaces","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /workspaces/v2/organizations/{orgId}","href":"/api-reference/workspaces/list-workspaces"},{"title":"Create a workspace","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json post /workspaces/v2/organizations/{orgId}","href":"/api-reference/workspaces/create-a-workspace"}]},{"group":"Workspace Presets","pages":[{"title":"List presets","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /workspaces/v2/organizations/{orgId}/{workspaceId}/presets","href":"/api-reference/workspace-presets/list-presets"},{"title":"Create a preset","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json post /workspaces/v2/organizations/{orgId}/{workspaceId}/presets","href":"/api-reference/workspace-presets/create-a-preset"},{"title":"Delete a preset","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json delete /workspaces/v2/organizations/{orgId}/{workspaceId}/presets/{presetId}","href":"/api-reference/workspace-presets/delete-a-preset"},{"title":"Update a preset","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json patch /workspaces/v2/organizations/{orgId}/{workspaceId}/presets/{presetId}","href":"/api-reference/workspace-presets/update-a-preset"},{"title":"Apply a preset","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json post /workspaces/v2/organizations/{orgId}/{workspaceId}/presets/{presetId}/promotions","href":"/api-reference/workspace-presets/apply-a-preset"}]},{"group":"Profile Groups","pages":[{"title":"List profile groups","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json get /workspaces/v2/organizations/{orgId}/{workspaceId}/profile-groups","href":"/api-reference/profile-groups/list-profile-groups"},{"title":"Create a profile group","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json post /workspaces/v2/organizations/{orgId}/{workspaceId}/profile-groups","href":"/api-reference/profile-groups/create-a-profile-group"},{"title":"Delete a profile group","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json delete /workspaces/v2/organizations/{orgId}/{workspaceId}/profile-groups/{profileGroupId}","href":"/api-reference/profile-groups/delete-a-profile-group"},{"title":"Update a profile group","deprecated":null,"version":null,"openapi":"/api-reference/admin-api.json patch /workspaces/v2/organizations/{orgId}/{workspaceId}/profile-groups/{profileGroupId}","href":"/api-reference/profile-groups/update-a-profile-group"}]}]},{"group":"Profiles - Endpoints","pages":[{"group":"Profile Management","pages":[{"title":"Create and screen a profile","deprecated":null,"version":null,"openapi":"/api-reference/profiles.json post /onboarding/profiles","href":"/api-reference/profile-management/create-and-screen-a-profile"},{"title":"List profiles","deprecated":null,"version":null,"openapi":"/api-reference/profiles.json get /profiles","href":"/api-reference/profile-management/list-profiles"},{"title":"Create a profile","deprecated":null,"version":null,"openapi":"/api-reference/profiles.json post /profiles","href":"/api-reference/profile-management/create-a-profile"},{"title":"Get profile details","deprecated":null,"version":null,"openapi":"/api-reference/profiles.json get /profiles/{profileId}","href":"/api-reference/profile-management/get-profile-details"},{"title":"Update a profile","deprecated":null,"version":null,"openapi":"/api-reference/profiles.json patch /profiles/{profileId}","href":"/api-reference/profile-management/update-a-profile"},{"title":"Add a profile comment","deprecated":null,"version":null,"openapi":"/api-reference/profiles.json post /profiles/{profileId}/comments","href":"/api-reference/profile-management/add-a-profile-comment"},{"title":"Generate a profile audit PDF","deprecated":null,"version":null,"openapi":"/api-reference/profiles.json post /profile-audit-reports/v1/profiles/{profile_id}/pdf","href":"/api-reference/profile-management/generate-a-profile-audit-pdf"},{"title":"List profile groups","deprecated":null,"version":null,"openapi":"/api-reference/profiles.json get /profile-groups","href":"/api-reference/profile-management/list-profile-groups"},{"title":"Create a profile group","deprecated":null,"version":null,"openapi":"/api-reference/profiles.json post /profile-groups","href":"/api-reference/profile-management/create-a-profile-group"},{"title":"Get a profile group","deprecated":null,"version":null,"openapi":"/api-reference/profiles.json get /profile-groups/{profileGroupId}","href":"/api-reference/profile-management/get-a-profile-group"},{"title":"Archive a profile group","deprecated":null,"version":null,"openapi":"/api-reference/profiles.json delete /profile-groups/{profileGroupId}","href":"/api-reference/profile-management/archive-a-profile-group"},{"title":"Update a profile group","deprecated":null,"version":null,"openapi":"/api-reference/profiles.json patch /profile-groups/{profileGroupId}","href":"/api-reference/profile-management/update-a-profile-group"}]},{"group":"Potential Matches","pages":[{"title":"Update potential match status","deprecated":null,"version":null,"openapi":"/api-reference/profiles.json patch /v2/search/matches/{match_id}","href":"/api-reference/potential-matches/update-potential-match-status"}]}]},{"group":"Agent Risk Assessments - Endpoints","pages":[{"group":"Configuration","pages":[{"title":"List risk assessment workflows","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json get /workflows","href":"/api-reference/configuration/list-risk-assessment-workflows"},{"title":"List assessment and task statuses","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json get /status-definitions","href":"/api-reference/configuration/list-assessment-and-task-statuses"},{"title":"List client risk rating scorecards","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json get /crr-scorecards","href":"/api-reference/configuration/list-client-risk-rating-scorecards"}]},{"group":"Assessments","pages":[{"title":"List risk assessments","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json get /assessments","href":"/api-reference/assessments/list-risk-assessments"},{"title":"Create a risk assessment","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json post /assessments","href":"/api-reference/assessments/create-a-risk-assessment"},{"title":"Get a risk assessment","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json get /assessments/{assessmentId}","href":"/api-reference/assessments/get-a-risk-assessment"},{"title":"Get assessment summary","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json get /assessments/{assessmentId}/summary","href":"/api-reference/assessments/get-assessment-summary"},{"title":"Get assessment tasks, notes, and interrupts","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json get /assessments/{assessmentId}/tasks","href":"/api-reference/assessments/get-assessment-tasks-notes-and-interrupts"},{"title":"Update assessment title","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json patch /assessments/{assessmentId}/title","href":"/api-reference/assessments/update-assessment-title"},{"title":"Append assessment uploads","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json post /assessments/{assessmentId}/uploads","href":"/api-reference/assessments/append-assessment-uploads"},{"title":"Start an assessment agent run","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json post /assessments/{assessmentId}/start","href":"/api-reference/assessments/start-an-assessment-agent-run"},{"title":"Stop an assessment and its latest run","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json post /assessments/{assessmentId}/stop","href":"/api-reference/assessments/stop-an-assessment-and-its-latest-run"},{"title":"Cancel an assessment and its latest run","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json post /assessments/{assessmentId}/cancel","href":"/api-reference/assessments/cancel-an-assessment-and-its-latest-run"},{"title":"Conclude an assessment","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json post /assessments/{assessmentId}/conclude","href":"/api-reference/assessments/conclude-an-assessment"}]},{"group":"Review And Collaboration","pages":[{"title":"List assessment comments","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json get /assessments/{assessmentId}/comments","href":"/api-reference/review-and-collaboration/list-assessment-comments"},{"title":"Add an assessment comment","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json post /assessments/{assessmentId}/comments","href":"/api-reference/review-and-collaboration/add-an-assessment-comment"},{"title":"Update task status","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json patch /assessments/{assessmentId}/tasks/{taskId}/status","href":"/api-reference/review-and-collaboration/update-task-status"},{"title":"Update task details","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json patch /assessments/{assessmentId}/tasks/{taskId}","href":"/api-reference/review-and-collaboration/update-task-details"},{"title":"Append assessment notes","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json post /assessments/{assessmentId}/notes/append","href":"/api-reference/review-and-collaboration/append-assessment-notes"},{"title":"Replace assessment notes","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json put /assessments/{assessmentId}/notes","href":"/api-reference/review-and-collaboration/replace-assessment-notes"},{"title":"Answer an agent question","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json post /assessments/{assessmentId}/questions/{questionId}/answer","href":"/api-reference/review-and-collaboration/answer-an-agent-question"},{"title":"Resolve an agent confirmation","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json post /assessments/{assessmentId}/confirmations/{confirmationId}/resolve","href":"/api-reference/review-and-collaboration/resolve-an-agent-confirmation"}]},{"group":"Relationships Canvas","pages":[{"title":"Get or create the default canvas","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json get /assessments/{assessmentId}/canvas","href":"/api-reference/relationships-canvas/get-or-create-the-default-canvas"},{"title":"Save the default canvas","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json put /assessments/{assessmentId}/canvas","href":"/api-reference/relationships-canvas/save-the-default-canvas"},{"title":"List assessment canvases","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json get /assessments/{assessmentId}/canvases","href":"/api-reference/relationships-canvas/list-assessment-canvases"},{"title":"Create a canvas","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json post /assessments/{assessmentId}/canvases","href":"/api-reference/relationships-canvas/create-a-canvas"},{"title":"Get a canvas by ID","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json get /assessments/{assessmentId}/canvases/{canvasId}","href":"/api-reference/relationships-canvas/get-a-canvas-by-id"},{"title":"Rename a canvas","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json patch /assessments/{assessmentId}/canvases/{canvasId}","href":"/api-reference/relationships-canvas/rename-a-canvas"},{"title":"Delete a canvas","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json delete /assessments/{assessmentId}/canvases/{canvasId}","href":"/api-reference/relationships-canvas/delete-a-canvas"},{"title":"Save a canvas by ID","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json put /assessments/{assessmentId}/canvases/{canvasId}","href":"/api-reference/relationships-canvas/save-a-canvas-by-id"}]},{"group":"Agent Runtime","pages":[{"title":"Get the latest assessment run","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json get /assessments/{assessmentId}/run","href":"/api-reference/agent-runtime/get-the-latest-assessment-run"},{"title":"Get an assessment run by ID","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json get /assessments/{assessmentId}/runs/{runId}","href":"/api-reference/agent-runtime/get-an-assessment-run-by-id"},{"title":"List the latest run trajectory","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json get /assessments/{assessmentId}/trajectory","href":"/api-reference/agent-runtime/list-the-latest-run-trajectory"},{"title":"List run trajectory by run ID","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json get /assessments/{assessmentId}/runs/{runId}/trajectory","href":"/api-reference/agent-runtime/list-run-trajectory-by-run-id"},{"title":"List commands on the latest run","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json get /assessments/{assessmentId}/commands","href":"/api-reference/agent-runtime/list-commands-on-the-latest-run"},{"title":"List run commands by run ID","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json get /assessments/{assessmentId}/runs/{runId}/commands","href":"/api-reference/agent-runtime/list-run-commands-by-run-id"},{"title":"Create a command on the latest run","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json post /assessments/{assessmentId}/commands","href":"/api-reference/agent-runtime/create-a-command-on-the-latest-run"},{"title":"Create a run command by run ID","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json post /assessments/{assessmentId}/runs/{runId}/commands","href":"/api-reference/agent-runtime/create-a-run-command-by-run-id"},{"title":"Send user input to the latest run","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json post /assessments/{assessmentId}/input","href":"/api-reference/agent-runtime/send-user-input-to-the-latest-run"},{"title":"Send user input to a run by run ID","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json post /assessments/{assessmentId}/runs/{runId}/input","href":"/api-reference/agent-runtime/send-user-input-to-a-run-by-run-id"},{"title":"Steer the latest run","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json post /assessments/{assessmentId}/steer","href":"/api-reference/agent-runtime/steer-the-latest-run"},{"title":"Steer a run by run ID","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json post /assessments/{assessmentId}/runs/{runId}/steer","href":"/api-reference/agent-runtime/steer-a-run-by-run-id"},{"title":"Resume the latest run","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json post /assessments/{assessmentId}/resume","href":"/api-reference/agent-runtime/resume-the-latest-run"},{"title":"Resume a run by run ID","deprecated":null,"version":null,"openapi":"/api-reference/risk-assessment-agents.json post /assessments/{assessmentId}/runs/{runId}/resume","href":"/api-reference/agent-runtime/resume-a-run-by-run-id"}]}]},{"group":"Identity Verification - Endpoints","pages":[{"group":"Sessions","pages":[{"title":"Create an IDV session","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json post /sessions","href":"/api-reference/sessions/create-an-idv-session"},{"title":"List sessions","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json get /sessions","href":"/api-reference/sessions/list-sessions"},{"title":"Poll a session","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json get /sessions/{sessionId}","href":"/api-reference/sessions/poll-a-session"},{"title":"Send a verification invite","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json post /sessions/{sessionId}/invite","href":"/api-reference/sessions/send-a-verification-invite"},{"title":"Cancel a session","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json post /sessions/{sessionId}/cancel","href":"/api-reference/sessions/cancel-a-session"},{"title":"Public branding for a session","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json get /sessions/{sessionId}/branding","href":"/api-reference/sessions/public-branding-for-a-session"},{"title":"Public session logo bytes","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json get /sessions/{sessionId}/branding/logo","href":"/api-reference/sessions/public-session-logo-bytes"},{"title":"Public session square-logo bytes","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json get /sessions/{sessionId}/branding/logo/square","href":"/api-reference/sessions/public-session-square-logo-bytes"}]},{"group":"Capture","pages":[{"title":"Exchange an invite for a fresh capture token","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json post /sessions/{sessionId}/acquire","href":"/api-reference/capture/exchange-an-invite-for-a-fresh-capture-token"},{"title":"Session-scoped progress for the capture UI","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json get /sessions/{sessionId}/status","href":"/api-reference/capture/session-scoped-progress-for-the-capture-ui"},{"title":"Record consumer consent","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json post /sessions/{sessionId}/consent","href":"/api-reference/capture/record-consumer-consent"},{"title":"Reserve an artifact slot","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json post /sessions/{sessionId}/artifacts","href":"/api-reference/capture/reserve-an-artifact-slot"},{"title":"Upload artifact bytes","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json put /sessions/{sessionId}/artifacts/{artifactId}/object","href":"/api-reference/capture/upload-artifact-bytes"},{"title":"Submit questionnaire answers","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json put /sessions/{sessionId}/steps/{stepId}/answers","href":"/api-reference/capture/submit-questionnaire-answers"},{"title":"Skip an optional step","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json post /sessions/{sessionId}/steps/{stepId}/skip","href":"/api-reference/capture/skip-an-optional-step"},{"title":"Record the document type","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json post /sessions/{sessionId}/document-type","href":"/api-reference/capture/record-the-document-type"},{"title":"Submit for assessment","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json post /sessions/{sessionId}/submit","href":"/api-reference/capture/submit-for-assessment"}]},{"group":"Review","pages":[{"title":"Apply a human review decision","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json post /sessions/{sessionId}/review","href":"/api-reference/review/apply-a-human-review-decision"},{"title":"Get decrypted session data","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json get /sessions/{sessionId}/data","href":"/api-reference/review/get-decrypted-session-data"},{"title":"Per-profile review summary","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json get /profiles/{profileId}/review-summary","href":"/api-reference/review/per-profile-review-summary"}]},{"group":"Workflows","pages":[{"title":"Create a workflow","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json post /workflows","href":"/api-reference/workflows/create-a-workflow"},{"title":"List workflows (newest first)","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json get /workflows","href":"/api-reference/workflows/list-workflows-newest-first"},{"title":"Show a workflow","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json get /workflows/{workflowId}","href":"/api-reference/workflows/show-a-workflow"},{"title":"Replace a workflow","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json put /workflows/{workflowId}","href":"/api-reference/workflows/replace-a-workflow"},{"title":"Activate a workflow","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json post /workflows/{workflowId}/activate","href":"/api-reference/workflows/activate-a-workflow"},{"title":"Archive a workflow","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json post /workflows/{workflowId}/archive","href":"/api-reference/workflows/archive-a-workflow"},{"title":"Make a workflow the scope default","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json post /workflows/{workflowId}/default","href":"/api-reference/workflows/make-a-workflow-the-scope-default"},{"title":"Delete a workflow","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json delete /workflows/{workflowId}","href":"/api-reference/workflows/delete-a-workflow"}]},{"group":"Themes","pages":[{"title":"Create a theme","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json post /themes","href":"/api-reference/themes/create-a-theme"},{"title":"List themes (newest first)","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json get /themes","href":"/api-reference/themes/list-themes-newest-first"},{"title":"Show a theme","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json get /themes/{themeId}","href":"/api-reference/themes/show-a-theme"},{"title":"Replace a theme","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json put /themes/{themeId}","href":"/api-reference/themes/replace-a-theme"},{"title":"Activate a theme","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json post /themes/{themeId}/activate","href":"/api-reference/themes/activate-a-theme"},{"title":"Archive a theme","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json post /themes/{themeId}/archive","href":"/api-reference/themes/archive-a-theme"},{"title":"Make a theme the scope default","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json post /themes/{themeId}/default","href":"/api-reference/themes/make-a-theme-the-scope-default"},{"title":"Upload a logo","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json put /themes/{themeId}/logo","href":"/api-reference/themes/upload-a-logo"},{"title":"Stream the theme's logo","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json get /themes/{themeId}/logo","href":"/api-reference/themes/stream-the-themes-logo"},{"title":"Remove the theme's logo reference","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json delete /themes/{themeId}/logo","href":"/api-reference/themes/remove-the-themes-logo-reference"},{"title":"Upload the square logo","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json put /themes/{themeId}/logo/square","href":"/api-reference/themes/upload-the-square-logo"},{"title":"Stream the theme's square logo","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json get /themes/{themeId}/logo/square","href":"/api-reference/themes/stream-the-themes-square-logo"},{"title":"Remove the theme's square logo reference","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json delete /themes/{themeId}/logo/square","href":"/api-reference/themes/remove-the-themes-square-logo-reference"},{"title":"Delete a theme","deprecated":null,"version":null,"openapi":"/api-reference/idv-svc.json delete /themes/{themeId}","href":"/api-reference/themes/delete-a-theme"}]}]}]}]},"basePath":"","title":"Update a custom list - Minerva Docs","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C9Wu0MeN.js","utils-jWgu-6Qf.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DBD8f9qn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BGuX1ui5.js","snippetPresets-Evy63nQB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BQHO1lnV.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B6C8m-t_.js","shallow-BG4cT0fH.js","getApiPlaygroundDisplay-CgEPrE-D.js","CodeSnippet-CU8JyZ9N.js","CodeSnippets-BnxHU32T.js","Page-D6S0Yh6q.js","getPastedJson-CwiYOonh.js","icon-DYDpWmDf.js","MethodPill-C-J-l7_c.js","DuplicateIcon-B6ARwg9w.js","createIcon-Dsv4MtDq.js","DynamicMarkdown-CtasenyM.js","SectionHeading-YNcgYwjB.js","axios-vUo_bRtp.js","Markdown-CwLx6PAg.js","clsx-C3kuh_dz.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CmKHfscc.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-U3mI6Ljh.js"]}