Skip to main content
POST
Create segment

Authorizations

Authorization
string
header
required

Bearer token authentication using your API key

Body

Schema for creating a segment

name
string
required

Name of the segment

Required string length: 1 - 128
color
enum<string>

Accent color, by name

Available options:
red,
orange,
amber,
yellow,
lime,
green,
teal,
cyan,
sky,
blue,
indigo,
violet,
purple,
fuchsia,
pink,
rose,
neutral

Response

200 - application/json

Schema for the segment

id
string
required
name
string
required
color
enum<string>
required

Accent color, by name

Available options:
red,
orange,
amber,
yellow,
lime,
green,
teal,
cyan,
sky,
blue,
indigo,
violet,
purple,
fuchsia,
pink,
rose,
neutral
contacts_count
number
required
created_at
string<date-time>
required
updated_at
string<date-time>
required