Update a profile

PATCH /v1/profiles/{id}

Requires: profile.edit

Path Parameters

id required

string

- The profile ID

Request Body

- Profile update data

ProfileUpdateDto

dataoptional

Record<string, any>

Construct a type with a set of properties K of type T

inheritsoptional

string

nameoptional

string

Example Request

application/json

{
  "name": "string",
  "data": {},
  "inherits": "string"
}

Response Schema

Profile

compatibilityListrequired

string

createdAtrequired

string

format: date-time

datarequired

Record<string, any>

Construct a type with a set of properties K of type T

externalIdrequired

string

idrequired

string

pattern: ^[a-z0-9]{24}$

inheritsrequired

string

integrationIdrequired

string

integrationTyperequired

any

metadatarequired

Record<string, any>

Construct a type with a set of properties K of type T

namerequired

string

sourcerequired

any

storeIdrequired

string

pattern: ^[a-z0-9]{24}$

typerequired

any

updatedAtrequired

string

format: date-time

Example Response

200 OK — application/json

{
  "id": "string",
  "name": "string",
  "inherits": "string",
  "compatibilityList": "string",
  "data": {},
  "metadata": {},
  "storeId": "string",
  "updatedAt": "2026-08-24T03:58:56.056Z",
  "createdAt": "2026-08-24T03:58:56.056Z"
}