PATCH /profiles/:profileId - ARGOS Identity

Only the fields you send change. Folders and items are not affected.

Endpoint

PATCH /v1/profiles/{profileId}

Request

Path parameters

Parameter	Type	Description
`profileId`	`string`	ID of the profile to update (`pf_` prefix)

Request body

Field	Type	Description
`name`	`string`	Profile name
`description`	`string`	Description
`metadata`	`object`	Your own metadata. It is replaced in full, not merged

curl -X PATCH "https://client-omni-api.argosidentity.com/v1/profiles/pf_6h4y8s2f0v9n" \
  -H "x-api-key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "example (re-review)",
    "metadata": { "vendor_id": "VND-2026-0142", "review_round": "2" }
  }'

Sending metadata replaces the whole object. To change one key, send every existing key along with it.

Response (200 OK)

{
  "id": "pf_6h4y8s2f0v9n",
  "workflowId": "wf_3p8k2m5r9v1t",
  "name": "example (re-review)",
  "description": "Example profile for document verification",
  "metadata": { "vendor_id": "VND-2026-0142", "review_round": "2" },
  "itemsCount": 3,
  "foldersCount": 1,
  "lastAnalysisAt": "2026-09-10T05:41:09.220Z",
  "createdAt": "2026-09-10T05:32:47.118Z",
  "updatedAt": "2026-09-10T05:54:10.551Z"
}

The response has the same shape as an items[] entry in list profiles. Unlike reading a single profile, it does not carry the folders or recentAnalyses arrays.

Error codes

Status	Code	Description
404	`OMNI_3005`	Profile not found

Common errors (400 validation · 401 authentication · 403 permission · 500 server) are listed in the API overview.

⌘I