Space welcome
Which Doc or HTML node Home shows at the top as the space's welcome page. Write the guide as a node first, then owners and admins choose it here with optimistic version checks; members only see it if they can read that node.
The welcome page is an ordinary Doc or HTML node a space manager chose; Home shows it at the top for every member who can read that node. nodeId is null when none is set. Read the node itself with GET /nodes/{nodeId}.
Response Body
application/json
curl -X GET "https://example.com/api/v1/space-welcome"{ "spaceId": "string", "nodeId": "string", "version": 0, "updatedAt": "2019-08-24T14:15:22Z"}Write the guide as a Doc or HTML node first, then pass its id. The node must exist in this space and must not be archived or in the trash. nodeId: null clears the welcome. Use the version from the latest GET as expectedVersion (0 when never set). A concurrent change returns CONFLICT without overwriting it.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X PUT "https://example.com/api/v1/space-welcome" \ -H "Content-Type: application/json" \ -d '{ "nodeId": "string", "expectedVersion": 0 }'{ "spaceId": "string", "nodeId": "string", "version": 0, "updatedAt": "2019-08-24T14:15:22Z"}