Update a document

PATCH

updates a single document, for only the body and title

Path parameters

spaceIdstringRequired

ID of space to return

documentIdstringRequired

ID of document 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

PATCH

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

200Example0

1 {
2   "data": {
3     "body": "Updated My information",
4     "createdAt": "2022-09-18T00:19:57.007Z",
5     "id": "us_dc_YOUR_ID",
6     "title": "Updated Title",
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 PATCH https://api.x.flatfile.com/v1/spaces/us_sp_YOUR_ID/documents/us_dc_YOUR_ID \
2	-H "X-Disable-Hooks: true" \
3	-H "Authorization: Bearer <token>" \
4	-H "Content-Type: application/json" \
5	-d '{
6	"title": "Updated Title",
7	"body": "Updated My information"
8	}'

1	{
2	"data": {
3	"body": "Updated My information",
4	"createdAt": "2022-09-18T00:19:57.007Z",
5	"id": "us_dc_YOUR_ID",
6	"title": "Updated Title",
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	}