Update a guest

curl -X PATCH https://api.x.flatfile.com/v1/guests/us_g_YOUR_ID \
     -H "X-Disable-Hooks: true" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "email": "updated@example.com",
  "name": "Your Name Updated"
}'

{
  "data": {
    "createdAt": "2023-10-30T16:59:45.735Z",
    "email": "email@example.com",
    "environmentId": "us_env_YOUR_ID",
    "id": "us_g_YOUR_ID",
    "name": "Your Name",
    "spaces": [
      {
        "id": "us_sp_YOUR_ID",
        "workbooks": [
          {
            "id": "us_wb_YOUR_ID"
          }
        ],
        "sheets": [
          {
            "id": "us_sh_YOUR_ID"
          }
        ],
        "lastAccessed": "2023-10-30T16:59:45.735Z"
      }
    ],
    "updatedAt": "2023-10-30T16:59:45.735Z"
  }
}

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

Authentication

AuthorizationBearer

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

Path parameters

guestIdstringRequired

ID of guest to return

Request

This endpoint expects an object.

environmentIdstringOptional

Environment ID

emailstringOptional

namestringOptional

spaceslist of objectsOptional

Response

This endpoint returns an object.

dataobject

Update a guest

Authentication

Path parameters

Headers

Request

Response

Authentication

Path parameters

Headers

Request

Response

$	curl -X PATCH https://api.x.flatfile.com/v1/guests/us_g_YOUR_ID \
>	-H "X-Disable-Hooks: true" \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"email": "updated@example.com",
>	"name": "Your Name Updated"
>	}'

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	"sheets": [
17	{
18	"id": "us_sh_YOUR_ID"
19	}
20	],
21	"lastAccessed": "2023-10-30T16:59:45.735Z"
22	}
23	],
24	"updatedAt": "2023-10-30T16:59:45.735Z"
25	}
26	}