Create a guest

POST

Guests are only there to upload, edit, and download files and perform their tasks in a specific Space.

Headers

X-Disable-Hooks"true"RequiredDefaults to true

Request

This endpoint expects a list of objects.

environmentIdstringRequired

Environment ID

emailstringRequired

namestringRequired

spaceslist of objectsRequired

Response

This endpoint returns an object.

datalist of objects

POST

1 curl -X POST https://api.x.flatfile.com/v1/guests \
2      -H "X-Disable-Hooks: true" \
3      -H "Authorization: Bearer <token>" \
4      -H "Content-Type: application/json" \
5      -d '[
6   {
7     "environmentId": "us_env_YOUR_ID",
8     "email": "email@example.com",
9     "name": "Your Name",
10     "spaces": [
11       {
12         "id": "us_sp_YOUR_ID",
13         "workbooks": [
14           {
15             "id": "us_wb_YOUR_ID"
16           }
17         ],
18         "lastAccessed": "2023-10-30T16:59:45.735Z"
19       }
20     ]
21   }
22 ]'

200Successful

1 {
2   "data": [
3     {
4       "createdAt": "2023-10-30T16:59:45.735Z",
5       "email": "email@example.com",
6       "environmentId": "us_env_YOUR_ID",
7       "id": "us_g_YOUR_ID",
8       "name": "Your Name",
9       "spaces": [
10         {
11           "id": "us_sp_YOUR_ID",
12           "workbooks": [
13             {
14               "id": "us_wb_YOUR_ID"
15             }
16           ],
17           "lastAccessed": "2023-10-30T16:59:45.735Z"
18         }
19       ],
20       "updatedAt": "2023-10-30T16:59:45.735Z"
21     }
22   ]
23 }

Built with

1	curl -X POST https://api.x.flatfile.com/v1/guests \
2	-H "X-Disable-Hooks: true" \
3	-H "Authorization: Bearer <token>" \
4	-H "Content-Type: application/json" \
5	-d '[
6	{
7	"environmentId": "us_env_YOUR_ID",
8	"email": "email@example.com",
9	"name": "Your Name",
10	"spaces": [
11	{
12	"id": "us_sp_YOUR_ID",
13	"workbooks": [
14	{
15	"id": "us_wb_YOUR_ID"
16	}
17	],
18	"lastAccessed": "2023-10-30T16:59:45.735Z"
19	}
20	]
21	}
22	]'

1	{
2	"data": [
3	{
4	"createdAt": "2023-10-30T16:59:45.735Z",
5	"email": "email@example.com",
6	"environmentId": "us_env_YOUR_ID",
7	"id": "us_g_YOUR_ID",
8	"name": "Your Name",
9	"spaces": [
10	{
11	"id": "us_sp_YOUR_ID",
12	"workbooks": [
13	{
14	"id": "us_wb_YOUR_ID"
15	}
16	],
17	"lastAccessed": "2023-10-30T16:59:45.735Z"
18	}
19	],
20	"updatedAt": "2023-10-30T16:59:45.735Z"
21	}
22	]
23	}