Update a space

PATCH

Update a space, to change the name for example

Path parameters

spaceIdstringRequired

ID of space to update

Headers

X-Disable-Hooks"true"Required

Request

This endpoint expects an object.

accesslist of "*" or "upload"Optional

Allowed values: *upload

actionslist of objectsOptional

appIdstringOptional

The ID of the App that space is associated with

archivedAtdatetimeOptional

Date when space was archived

autoConfigurebooleanOptional

displayOrderintegerOptional

The display order

environmentIdstringOptional

Environment ID

guestAuthenticationlist of "shared_link" or "magic_link"Optional

Allowed values: shared_linkmagic_link

labelslist of stringsOptional

languageOverridestringOptional

metadataanyOptional

Metadata for the space

namestringOptional

The name of the space

namespacestringOptional

primaryWorkbookIdstringOptional

The ID of the primary workbook for the space. This should not be included in create space requests.

settingsobjectOptional

The Space settings.

spaceConfigIdstringOptional

Space Config ID

translationsPathstringOptional

Response

This endpoint returns an object.

dataobject

A place to store your workbooks

Errors

PATCH

1 curl -X PATCH https://api.x.flatfile.com/v1/spaces/us_sp_YOUR_ID \
2      -H "X-Disable-Hooks: true" \
3      -H "Authorization: Bearer <token>" \
4      -H "Content-Type: application/json" \
5      -d '{
6   "name": "My Updated Worbook"
7 }'

200Example0

1 {
2   "data": {
3     "createdAt": "2021-01-01T00:00:00.000Z",
4     "guestAuthentication": [
5       "magic_link",
6       "shared_link"
7     ],
8     "id": "us_sp_YOUR_ID",
9     "name": "My Updated Worbook",
10     "updatedAt": "2021-01-01T00:00:00.000Z",
11     "createdByUserId": "us_usr_YOUR_ID",
12     "displayOrder": 1,
13     "environmentId": "us_env_YOUR_ID",
14     "filesCount": 1,
15     "isCollaborative": true,
16     "labels": [],
17     "lastActivityAt": "2021-01-01T00:00:00.000Z",
18     "metadata": null,
19     "primaryWorkbookId": "us_wb_YOUR_ID",
20     "upgradedAt": "2021-01-01T00:00:00.000Z",
21     "workbooksCount": 1
22   }
23 }

Built with

1	curl -X PATCH https://api.x.flatfile.com/v1/spaces/us_sp_YOUR_ID \
2	-H "X-Disable-Hooks: true" \
3	-H "Authorization: Bearer <token>" \
4	-H "Content-Type: application/json" \
5	-d '{
6	"name": "My Updated Worbook"
7	}'

1	{
2	"data": {
3	"createdAt": "2021-01-01T00:00:00.000Z",
4	"guestAuthentication": [
5	"magic_link",
6	"shared_link"
7	],
8	"id": "us_sp_YOUR_ID",
9	"name": "My Updated Worbook",
10	"updatedAt": "2021-01-01T00:00:00.000Z",
11	"createdByUserId": "us_usr_YOUR_ID",
12	"displayOrder": 1,
13	"environmentId": "us_env_YOUR_ID",
14	"filesCount": 1,
15	"isCollaborative": true,
16	"labels": [],
17	"lastActivityAt": "2021-01-01T00:00:00.000Z",
18	"metadata": null,
19	"primaryWorkbookId": "us_wb_YOUR_ID",
20	"upgradedAt": "2021-01-01T00:00:00.000Z",
21	"workbooksCount": 1
22	}
23	}