Create | Flatfile | API Reference

Creates a new flag for the workbook

AuthorizationBearer

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

workbookIdstringRequired

The workbook ID to manage flags for

This endpoint expects an object.

slugstringRequired

The unique identifier for the flag

labelstringRequired

The human-readable name for the flag

colorHexstringRequired

The hex color code for the flag (e.g., “#0090FF”)

This endpoint returns an object.

idstring

The unique identifier for the flag

slugstring

The flag slug

labelstring

The flag label

colorHexstring

The hex color code for the flag

workbookIdstring

The workbook this flag belongs to

createdAtdatetime

When the flag was created

updatedAtdatetime

When the flag was last updated

1	import { FlatfileClient } from "@flatfile/api";
2
3	const client = new FlatfileClient({ token: "YOUR_TOKEN" });
4	await client.flags.create("us_wb_YOUR_ID", {
5	slug: "important",
6	label: "Important",
7	colorHex: "#0090FF"
8	});