Create a guide

1 import { FlatfileClient } from "@flatfile/api"; 2 3 const client = new FlatfileClient({ token: "YOUR_TOKEN" }); 4 await client.environments.createGuide("us_env_YOUR_ID", { 5 description: "Getting started guide", 6 title: "Data import made easy", 7 slug: "getting-started", 8 environmentId: "commons.EnvironmentId", 9 blocks: [], 10 metadata: { 11 "category": "onboarding" 12 } 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 }

Creates a guide

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path Parameters

environmentIdstringRequired

ID of the environment

Request

This endpoint expects an object.

descriptionstringRequired

titlestringRequired

slugstringRequired

blockslist of optional maps from strings to anyRequired

environmentIdstringRequired

metadatamap from strings to anyOptional

Response

This endpoint returns an object.

dataobject

A guide

Authentication

Path Parameters

Headers

Request

Response

Errors