Skip to main content
PATCH
/
users
/
:id
Update an individual User
curl --request PATCH \
  --url https://app.ledger.ai/api/users/:id \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
filters
string

Update item with the given ids: [ id ]

JSON PATCH body:

{
  "about"?: null | string
  "auth0_user_id"?: null | string
  "contact_preference"?: null | integer[]
  "contact_times"?: null | integer-range[]
  "data"?: null | object
  "email"?: string
  "family_name"?: string
  "given_name"?: string
  "invite_code_expires_at"?: null | timestamp
  "invite_code"?: null | string
  "nickname"?: string
  "picture"?: null | string
  "timezone"?: null | string
}

Set a field to null to unset it, leave it absent in the patch to retain the existing value.

Body

application/json

Request payload

The body is of type object.

Response

Successful response

The response is of type object.