Update a guide

PATCH

Updates a guide

Path parameters

environmentIdstringRequired

ID of the environment

guideIdstringRequired

ID of guide

Headers

X-Disable-Hooks"true"Required

Request

This endpoint expects an object.

descriptionstringOptional

titlestringOptional

metadatamap from strings to anyOptional

slugstringOptional

versionslist of objectsOptional

blockslist of optional maps from strings to anyOptional

environmentIdstringOptional

Response

This endpoint returns an object.

dataobject

A guide

Errors

PATCH

1 curl -X PATCH https://api.x.flatfile.com/v1/environments/us_env_YOUR_ID/guides/us_gu_YOUR_ID \
2      -H "X-Disable-Hooks: true" \
3      -H "Authorization: Bearer <token>" \
4      -H "Content-Type: application/json" \
5      -d '{
6   "description": "Updated getting started guide",
7   "title": "Data import made easy",
8   "metadata": {
9     "category": "onboarding"
10   },
11   "slug": "getting-started",
12   "environmentId": "commons.EnvironmentId"
13 }'

200Example0

1 {
2   "data": {
3     "id": "us_gu_YOUR_ID",
4     "slug": "getting-started",
5     "title": "Importing your data",
6     "versions": [],
7     "blocks": [],
8     "createdAt": "2023-10-30T16:59:45.735Z",
9     "updatedAt": "2023-10-30T16:59:45.735Z",
10     "description": "Getting started guide",
11     "metadata": {
12       "category": "onboarding"
13     }
14   }
15 }

Built with

1	curl -X PATCH https://api.x.flatfile.com/v1/environments/us_env_YOUR_ID/guides/us_gu_YOUR_ID \
2	-H "X-Disable-Hooks: true" \
3	-H "Authorization: Bearer <token>" \
4	-H "Content-Type: application/json" \
5	-d '{
6	"description": "Updated getting started guide",
7	"title": "Data import made easy",
8	"metadata": {
9	"category": "onboarding"
10	},
11	"slug": "getting-started",
12	"environmentId": "commons.EnvironmentId"
13	}'

1	{
2	"data": {
3	"id": "us_gu_YOUR_ID",
4	"slug": "getting-started",
5	"title": "Importing your data",
6	"versions": [],
7	"blocks": [],
8	"createdAt": "2023-10-30T16:59:45.735Z",
9	"updatedAt": "2023-10-30T16:59:45.735Z",
10	"description": "Getting started guide",
11	"metadata": {
12	"category": "onboarding"
13	}
14	}
15	}