Skip to main content
POST
Create a segment

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required

segment name

segment_type
enum<string>
required
Available options:
dynamic,
manual
status
enum<string>

default status is draft

Available options:
draft,
active,
inactive,
archived
tags
string[]
meta
object[]

meta data in key-value pair. example - [{"key":"value"}]

description
string
archived_at
string<date-time>
segment_members
string[] | null
write-only

accepts array of email ids. (valid emails only). send null value if members list is empty or to remove all existing members.

Response

200 - application/json

OK

message
string
success
boolean
content
object