Update person field value

PATCH/api/unstable/people/{id}/value

Updates a single person field or custom field in the current workspace.

Request Body

application/json

key*string

Field key to update.

Example"name"

Example"data.customers"

Example"customFields.region"

value*unknown

New value to persist for the selected field.

Example"Ana Torres"

Example

[
  "customer_123"
]

[key: string]?never

Response Body

`application/json`

curl -X PATCH "https://loading/api/unstable/people/{id}/value" \  -H "Content-Type: application/json" \  -d '{    "key": "name",    "value": "Ana Torres"  }'

{
  "success": true
}

{
  "issues": [
    {
      "_tag": "Pointer",
      "path": [
        "string"
      ],
      "message": "string"
    }
  ],
  "message": "string",
  "_tag": "HttpApiDecodeError"
}

Empty

{
  "message": "string",
  "_tag": "ApiForbiddenError"
}

{
  "message": "string",
  "_tag": "ApiNotFoundError"
}

{
  "message": "string",
  "_tag": "ApiConflictError"
}

{
  "message": "string",
  "_tag": "ApiUnprocessableEntityError"
}

Empty

{
  "message": "string",
  "_tag": "ApiTimeoutError"
}

Update person field value

Request Body

Response Body

200application/json

400application/json

401

403application/json

404application/json

409application/json

422application/json

503

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`