Segments

Create a segment

Dynamic segments require conditions and are computed immediately; static segments start empty and are managed via the members endpoints.

Pass dryRun: true to preview instead of create — identical to POST /v1/segments/preview, and name is not required. The alias exists because the MCP create_segment tool takes dryRun and tells agents to run one first: until this was honoured, carrying that parameter into the REST call created a live segment on every "preview", and deleting it afterwards did not undo the segment.entered activity it had already written onto contacts.

post/v1/segments

Request

  • Base URL: https://api.volanea.com
  • URL: https://api.volanea.com/v1/segments
  • Auth: HTTP bearer

Request body

namestring

Required unless dryRun is true.

descriptionstring
type'dynamic' | 'static'
dryRunboolean

Preview only — nothing is created. Returns the same shape as POST /v1/segments/preview.

Response

Preview, when dryRun is true.

dryRuntrue required
segmentIdunknown
countinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.