Update user private data

PATCH
/api/users/[user_id]/private_data

Path Parameters

user_id
string
Required

User Id

Body Parameters

private_data
object
Required

User's Private Data

Authentication

X-API-KEY
header
Required

Api key needed to access the endpoints. X-API-KEY: Your_API_Key

Headers

content-type
string
  • application/json
accept
string
  • application/json
  • application/problem+json

Responses

200
OK
400
Bad Request
422
Unprocessable Entity
404
Not Found
401
Unauthorized
403
Forbidden

Request Example

Request
curl -X PATCH "https://<your-domain>/api/users/{user_id}/private_data" \
 -H "X-API-KEY: <your-api-key>" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 --data-raw '{
  "private_data" : {
    "roles" : ["administrator"],
    "has_dashboard_access" : false,
    "member_since" : 1672511400
  }
}'

Response Example

Response
200 OK
{
"private_data": {
"roles": [ "administrator"
], "has_dashboard_access": false, "member_since": 1672511400
} }