Create a guide

POST

Creates a guide

Path parameters

environmentIdstringRequired

ID of the environment

Headers

X-Disable-Hooks"true"Required

Request

This endpoint expects an object.

descriptionstringRequired

titlestringRequired

slugstringRequired

versionslist of objectsRequired

blockslist of optional maps from strings to anyRequired

environmentIdstringRequired

metadatamap from strings to anyOptional

Response

This endpoint returns an object.

dataobject

A guide

Errors

POST

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

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 POST https://api.x.flatfile.com/v1/environments/us_env_YOUR_ID/guides \
2	-H "X-Disable-Hooks: true" \
3	-H "Authorization: Bearer <token>" \
4	-H "Content-Type: application/json" \
5	-d '{
6	"description": "Getting started guide",
7	"title": "Data import made easy",
8	"slug": "getting-started",
9	"versions": [],
10	"blocks": [],
11	"environmentId": "commons.EnvironmentId",
12	"metadata": {
13	"category": "onboarding"
14	}
15	}'

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	}