Persons

Update a person data parameter

Updates the value of the named data parameter for the specified person. Returns 400 data_not_found if the parameter does not exist, or 400 read_only_name if the parameter name is read-only. Returns 403 person_not_found if the person is not accessible.

put/v5/persons/{person_id}/data/{name}

Request

Base URL
https://api.extole.io
Auth
- API key in header Authorization
- or API key in query parameter access_token
- or API key in cookie extole_token
TypeScript
https://skmtc.dev/extole/apis/integration-api-server-to-extole/docs/v5/persons/:person_id/data/:name/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

person_idstring required

Extole person id.

namestring required

Name of the data parameter.

Request body

scope'CLIENT' | 'PRIVATE' | 'PUBLIC'

Visibility scope of the data parameter. Omit to leave unchanged.

valueobject

Value stored for the data parameter. Omit to leave unchanged.

Response

Updated person data parameter.

created_datestring required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

idstring required

Extole-assigned unique identifier for this data parameter entry.

namestring required

Name of the data parameter.

scope'CLIENT' | 'PRIVATE' | 'PUBLIC' required

Visibility scope of the data parameter.

updated_datestring required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

valueobject required

Value stored for the data parameter.

Example response

{
  "created_date": "2025-10-24T02:00:00-07:00",
  "updated_date": "2025-10-24T02:00:00-07:00"
}

Changes

No recorded changes to this operation across all 1 revision of this API.