ATattentive
Bulk Segment Operations
Segments

Add Bulk Segment Members

Changed on

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

post/v2/bulk/segments/members

Request

  • Base URL
    https://api.attentivemobile.com
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://ui-devel.attentivemobile.com/integrations/oauth-install?client_id={clientId}&redirect_uri={redirectUri}&scope={scope}
      Token URL: https://api.attentivemobile.com/v1/authorization-codes/tokens scopes: segments:write

Headers

Authorizationstring required

Authorization for the request

Request body

externalIdstring 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.

Example request

{
  "externalId": "loyalty_gold_2025",
  "members": [
    {
      "email": "customer1@example.com",
      "phone": "+14155551234"
    },
    {
      "email": "customer2@example.com",
      "clientUserId": "user-abc-123"
    },
    {
      "phone": "+14155555678",
      "clientUserId": "user-xyz-789"
    }
  ]
}

Response

The bulk job request was successfully received and accepted for asynchronous processing. The response includes a batchJobId to track the status of the job, along with a confirmation message. Processing has not yet completed, please use the job status endpoint to monitor progress and retrieve results once available.

messagestring

A human-readable message confirming that the bulk job was successfully submitted.

batchJobIdstring

A unique identifier representing the submitted batch job. Use this ID to query the job's status, retrieve results, or diagnose any errors related to the job. This ID is returned upon successful job submission and required for all follow-up actions related to the batch.

Changes