Skip to content
Scope

Update profile identity

PUT
/api/v1/profiles/{profileId}
 
curl --request PUT \
  --url https://example.com/api/v1/profiles/example \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "description": "example" }'

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
profileId
required
string

Request Body

Section titled “Request Body ”
Media type application/json
object
name
string
>= 1 characters <= 128 characters
description
string
<= 512 characters
Example generated
{
  "name": "example",
  "description": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Success

Media type application/json
object
_id
required
string
name
required
string
description
string
latestVersion
required
number
createdAt
required
string | null format: date-time
updatedAt
string | null format: date-time
deletedAt
string | null format: date-time
projectId
required
string
Example generated
{
  "_id": "example",
  "name": "example",
  "description": "example",
  "latestVersion": 1,
  "createdAt": "2026-04-15T12:00:00Z",
  "updatedAt": "2026-04-15T12:00:00Z",
  "deletedAt": "2026-04-15T12:00:00Z",
  "projectId": "example"
}