Skip to main content
POST
Node.js

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer rw_....

Required scope: project:write.

Body

application/json
name
string
required

Unique segment name inside the current project.

Required string length: 1 - 80
Example:

"vip-customers"

description
string | null

Optional description for operators and dashboards.

Required string length: 1 - 280
Example:

"Customers with priority transactional flows."

color
string | null

Optional hexadecimal accent color stored with the segment.

Pattern: ^#[0-9A-Fa-f]{6}$
Example:

"#0EA5E9"

Response

200 - application/json

Successful response

ok
boolean
required
data
object
required