Users

Update a user

PATCH
Updates a user

Path parameters

userIdstringRequired
The user id

Request

This endpoint expects an object.
name
stringOptional
dashboard
integerOptional

Response

This endpoint returns an object
data
object
Configurations for the user
PATCH
$curl -X PATCH https://api.x.flatfile.com/v1/users/%3AuserId \
>     -H "X-Disable-Hooks: true" \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{}'
Response
1{
2  "data": {
3    "accountId": "string",
4    "createdAt": "2023-01-01T00:00:00Z",
5    "email": "string",
6    "id": "string",
7    "idp": "string",
8    "metadata": {
9      "string": {}
10    },
11    "name": "string",
12    "updatedAt": "2023-01-01T00:00:00Z",
13    "dashboard": 0,
14    "idpRef": "string",
15    "lastSeenAt": "2023-01-01T00:00:00Z"
16  }
17}
Built with