Guests

Update a guest

PATCH
Updates a single guest, for example to change name or email

Path parameters

guestIdstringRequired
ID of guest to return

Request

This endpoint expects an object.
environmentId
stringOptional
Environment ID
email
stringOptional
name
stringOptional
spaces
list of objectsOptional

Response

This endpoint returns an object
data
object
PATCH
$curl -X PATCH https://api.x.flatfile.com/v1/guests/us_g_YOUR_ID \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "email": "updated@example.com",
>  "name": "Your Name Updated"
>}'
Response
1{
2  "data": {
3    "createdAt": "2023-10-30T16:59:45.735Z",
4    "email": "email@example.com",
5    "environmentId": "us_env_YOUR_ID",
6    "id": "us_g_YOUR_ID",
7    "name": "Your Name",
8    "spaces": [
9      {
10        "id": "us_sp_YOUR_ID",
11        "workbooks": [
12          {
13            "id": "us_wb_YOUR_ID"
14          }
15        ],
16        "lastAccessed": "2023-10-30T16:59:45.735Z"
17      }
18    ],
19    "updatedAt": "2023-10-30T16:59:45.735Z"
20  }
21}
Built with