Create new segment

Creates a new empty segment with the specified name and optional description.

Scopes Required: [segments:Write]

Default Rate Limit: 100 requests per second

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 1 and 240

The name of the segment. Cannot be empty or whitespace only. Leading and trailing whitespace will be trimmed.

string
length between 2 and 500

Optional description of the segment. If not provided, defaults to "Manual Segment Upload Public API V2". When provided, cannot be empty or whitespace only and must be at least 2 characters. Leading and trailing whitespace will be trimmed.

string
length between 1 and 255

Auto generated if not supplied. Optional externalId set on the segment. Cannot be empty or whitespace only. Leading and trailing whitespace will be trimmed.

Responses

400

Bad request - invalid parameters

401

Unauthorized - invalid or missing token

403

Access denied - insufficient permissions

429

Too many requests - rate limit exceeded

500

Internal server error

Language
Credentials
LoadingLoading…
Response
Choose an example:
application/json