Create a document

POST

Add a new document to the space

Path parameters

spaceIdstringRequired

ID of space to return

Headers

X-Disable-Hooks"true"Required

Request

This endpoint expects an object.

titlestringRequired

bodystringRequired

treatmentslist of stringsOptional

Certain treatments will cause your Document to look or behave differently.

actionslist of objectsOptional

Response

This endpoint returns an object.

dataobject

A document (markdown components) belong to a space

Errors

POST

1 curl -X POST https://api.x.flatfile.com/v1/spaces/us_sp_YOUR_ID/documents \
2      -H "X-Disable-Hooks: true" \
3      -H "Authorization: Bearer <token>" \
4      -H "Content-Type: application/json" \
5      -d '{
6   "title": "My Document 1",
7   "body": "My information",
8   "actions": [
9     {
10       "label": "Submit",
11       "description": "Submit data to webhook.site",
12       "mode": "foreground",
13       "operation": "submitAction",
14       "primary": true
15     }
16   ]
17 }'

200Example0

1 {
2   "data": {
3     "body": "My information",
4     "createdAt": "2022-09-18T00:19:57.007Z",
5     "id": "us_dc_YOUR_ID",
6     "title": "My Document 1",
7     "updatedAt": "2022-09-18T00:19:57.007Z",
8     "actions": [
9       {
10         "label": "Submit",
11         "description": "Submit data to webhook.site",
12         "mode": "foreground",
13         "operation": "submitAction",
14         "primary": true
15       }
16     ],
17     "environmentId": "us_env_YOUR_ID",
18     "spaceId": "us_sp_YOUR_ID",
19     "treatments": []
20   }
21 }

Built with

1	curl -X POST https://api.x.flatfile.com/v1/spaces/us_sp_YOUR_ID/documents \
2	-H "X-Disable-Hooks: true" \
3	-H "Authorization: Bearer <token>" \
4	-H "Content-Type: application/json" \
5	-d '{
6	"title": "My Document 1",
7	"body": "My information",
8	"actions": [
9	{
10	"label": "Submit",
11	"description": "Submit data to webhook.site",
12	"mode": "foreground",
13	"operation": "submitAction",
14	"primary": true
15	}
16	]
17	}'

1	{
2	"data": {
3	"body": "My information",
4	"createdAt": "2022-09-18T00:19:57.007Z",
5	"id": "us_dc_YOUR_ID",
6	"title": "My Document 1",
7	"updatedAt": "2022-09-18T00:19:57.007Z",
8	"actions": [
9	{
10	"label": "Submit",
11	"description": "Submit data to webhook.site",
12	"mode": "foreground",
13	"operation": "submitAction",
14	"primary": true
15	}
16	],
17	"environmentId": "us_env_YOUR_ID",
18	"spaceId": "us_sp_YOUR_ID",
19	"treatments": []
20	}
21	}