Skip to main content

Endpoint

PATCH /v1/profiles/{profileId}

Request

curl -X PATCH "http://client-omni-api.argosidentity.com/v1/profiles/{profileId}" \
  -H "x-api-key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John Doe - Updated",
    "metadata": { "internalRef": "CASE-2026-001" }
  }'

Request Body

name
string
Updated display name for the profile
description
string
Updated profile description
metadata
object
Updated custom metadata (replaces entire metadata object, not merged)

Response

{
  "id": "pf_a1b2c3d4",
  "workflowId": "wf_7a3f9c2e",
  "name": "John Doe - Updated",
  "description": "Updated description",
  "metadata": { "internalRef": "CASE-2026-001" },
  "itemsCount": 3,
  "lastAnalysisAt": "2026-03-15T10:30:00Z",
  "createdAt": "2026-03-15T10:00:00Z",
  "updatedAt": "2026-03-15T11:00:00Z"
}

Error Codes

StatusCodeDescription
404PROFILE_NOT_FOUNDProfile not found