Skip to content
API Reference
/
/
Update a client

Update a client

Request

Security
form_session or user_session or component_session or component_token or api_token
Path
client_idstring(ClientId)^cl_required

Client Identifier

Bodyapplication/jsonrequired
namestring
custom_attributesobject(CustomAttributes)

Record of custom attribute values keyed by string path.

property name*any(ScalarValueUnknown)additional property

Unknown value that should be a JSON scalar (string, number, boolean, or null) but is not runtime-validated. Use ScalarValue for validation at serialization boundaries.

curl -i -X PATCH \
  'https://docs.onboarded.com/_mock/openapi/api/v1/clients/{client_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "custom_attributes": {
      "property1": null,
      "property2": null
    },
    "property1": null,
    "property2": null
  }'

Responses

A client with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base client schema.

Bodyapplication/json
idstring(ClientId)^cl_required

Client Identifier

namestringrequired
custom_attributesobject(CustomAttributes)required

Record of custom attribute values keyed by string path.

created_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

updated_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

property name*any(ScalarValueUnknown)additional property

Unknown value that should be a JSON scalar (string, number, boolean, or null) but is not runtime-validated. Use ScalarValue for validation at serialization boundaries.

Response
{
  "id": "cl_abc123def456",
  "name": "string",
  "custom_attributes": {
    "property1": null,
    "property2": null
  },
  "created_at": "string",
  "updated_at": "string",
  "property1": null,
  "property2": null
}