Skip to main content

Endpoint

PATCH /v1/folders/{folderId}

Request

curl -X PATCH "http://client-omni-api.argosidentity.com/v1/folders/{folderId}" \
  -H "x-api-key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "ID Documents"
  }'

Request Body

name
string
required
New folder name

Response

{
  "id": "fld_xyz789",
  "profileId": "pf_a1b2c3d4",
  "name": "ID Documents",
  "isDefault": false,
  "itemsCount": 3,
  "createdAt": "2026-03-15T10:30:00Z",
  "updatedAt": "2026-03-15T11:00:00Z"
}
The default folder cannot be renamed or deleted.

Error Codes

StatusCodeDescription
400CANNOT_MODIFY_DEFAULT_FOLDERDefault folder cannot be renamed
404FOLDER_NOT_FOUNDFolder not found