Skip to main content
POST
TypeScript

Authorizations

Authorization
string
header
required

Project-bound Apollo Signal API key. Keys begin with ap_signal_ and must carry the permission shown on the operation.

Path Parameters

projectId
string
required

The project to create the segment in.

Body

application/json

Segment name and optional description.

Definition for a new project segment.

name
string
required

Developer-facing segment name.

Response

Segment created.

contactCount
integer<int32>
required
createdAt
string
required
id
string
required
name
string
required
object
string
required
projectId
string
required
unsubscribedCount
integer<int32>
required