Skip to main content
PUT
/
api
/
profiles
/
{profile_name}
Update Profile
curl --request PUT \
  --url https://api.example.com/api/profiles/{profile_name} \
  --header 'Content-Type: application/json' \
  --header 'anchor-api-key: <api-key>' \
  --data '
{
  "description": "Updated profile description.",
  "source": "session",
  "session_id": "550e8400-e29b-41d4-a716-446655440000"
}
'
{
  "status": "success"
}

Authorizations

​
anchor-api-key
string
header
required

API key passed in the header

Path Parameters

​
profile_name
string
required

The name of the profile to update.

Example:

"my-profile"

Body

application/json
​
description
string

The new description for the profile.

Example:

"Updated profile description."

​
source
enum<string>

The source of the profile data. Currently, only session is supported.

Available options:
session,
file_upload
Example:

"session"

​
session_id
string<uuid>

The session ID is required if the source is set to session. The session must belong to the user and be active.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Response

Profile updated successfully.

​
status
string
Example:

"success"