Add Bulk Segment Members

Add members to a segment in bulk. This endpoint accepts 1 to 10,000 members per request. Members are identified by email, phone number, and/or client user ID. The request is validated, queued for asynchronous processing, and a unique batch job ID is returned for tracking the status.

Request Limits:

  • Minimum: 1 member per request
  • Maximum: 10,000 members per request
  • Each individual record must not exceed 1 MiB (1,048,576 bytes); oversized records are rejected with a 413 in the job results and are not processed
  • At least one identifier (email, phone, or clientUserId) required per member

Processing:

  • Jobs are processed asynchronously
  • Use the batch job ID to check status via GET /v2/bulk/job/{bulkJobId}
  • Results available as downloadable .jsonl file when completed

Scopes Required: [segments:all]

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

The external ID of the segment. This is the client-provided unique identifier for the segment, as defined when creating the segment via the Segment API.

members
array of objects
required
length between 1 and 10000

Array of segment members to add or remove. Each member must have at least one identifier (email, phone, or clientUserId). Minimum 1 member, maximum 10,000 members per request.

members*
Responses

400

Invalid parameter in request query or body

401

Unauthorized

403

Access Denied

404

The specified resource was not found

429

The user has sent too many requests in a given amount of time

500

Internal Server Error

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