Search...
/
Community
Create Account
Sign in
Overview
Welcome
Authentication
Using Environments
API Reference
Accounts
Actions
Agents
Apps
Assistant
Commits
Data Retention Policies
Documents
Entitlements
Environments
Events
Files
Guests
Jobs
Mapping
Records
Roles
Secrets
Sheets
Snapshots
Spaces
GET
List spaces
POST
Create a space
GET
Get a space
DEL
Delete a space
DEL
Delete spaces
PATCH
Update a space
POST
Archives a space
POST
Unarchives a space
Users
Versions
Views
Workbooks
Community
Create Account
Sign in
API Reference
Spaces
Update a space
PATCH
https://api.x.flatfile.com/v1
/
spaces
/
:spaceId
Update a space, to change the name for example
Path parameters
spaceId
string
Required
ID of space to update
Request
This endpoint expects an object.
access
list of "*" or "upload"
Optional
Allowed values:
*
upload
actions
list of objects
Optional
Show 19 properties
appId
string
Optional
The ID of the App that space is associated with
archivedAt
datetime
Optional
Date when space was archived
autoConfigure
boolean
Optional
displayOrder
integer
Optional
The display order
environmentId
string
Optional
Environment ID
guestAuthentication
list of "shared_link" or "magic_link"
Optional
Allowed values:
shared_link
magic_link
The type of authentication to use for guests
labels
list of strings
Optional
languageOverride
string
Optional
metadata
any
Optional
Metadata for the space
name
string
Optional
The name of the space
namespace
string
Optional
primaryWorkbookId
string
Optional
The ID of the primary workbook for the space. This should not be included in create space requests.
settings
object
Optional
The Space settings.
Show property
spaceConfigId
string
Optional
Space Config ID
translationsPath
string
Optional
Response
This endpoint returns an object.
data
object
A place to store your workbooks
Show 31 properties
Errors
400
Bad Request
404
Not Found
Built with