Skip to main content
POST

Authorizations

Authorization
string
header
required

Workspace API key (e.g. formo_xxx). Create one in the Formo dashboard under Team Settings > API.

Headers

Idempotency-Key
string

Optional unique value (e.g. a UUID v4) that lets you safely retry POST/PUT/PATCH/DELETE requests. The first request runs normally; subsequent requests with the same key replay the stored response (status + body) for 24 hours, so retries can never double-create or double-charge. Two concurrent requests with the same key return 409 IDEMPOTENCY_IN_PROGRESS. Generate a fresh key per logical operation.

Maximum string length: 255

Body

application/json
title
string
required
Minimum string length: 1
filters
object[]
required

Canonical filter objects combined with implicit AND.

Minimum array length: 1

Response

Segment created

A saved segment. filters is an array of canonical filter objects combined with implicit AND.

id
string
required
title
string
required
filters
object[]
required
projectId
string