latestOpenAPI 3.0.12026-08-1848115403.9 KB

ae1e3ddfb2fb

Segment List

Add Subscribers to Segment List

Adds multiple new subscribers to an existing segment list in a single batch request. Each entry accepts contact details such as phone number, full name, email, avatar image, and geographic region metadata.

put/accounts/segment-lists/{listId}/subscribers

Path parameters

listIdstring required

The unique identifier of the target segment list where subscribers will be added.

Request body

subscriberNostring required

The mobile phone number of the subscriber.

firstNamestring nullable

The subscriber's first name.

lastNamestring nullable

The subscriber's last name.

emailstring nullable

The subscriber's first name.

imageUrlstring nullable

A direct URL hosting the subscriber's avatar or profile picture.

regionstring

The geographic territory or region assigned to the subscriber profile.

Example request

[
  {
    "subscriberNo": "198xxxxx100",
    "firstName": "Jane",
    "lastName": "Doe",
    "email": "jane.doe@example.com",
    "imageUrl": "https://example.com/avatars/janedoe.jpg",
    "region": "US"
  },
  {
    "subscriberNo": "198xxxxx101",
    "firstName": "John",
    "lastName": "Smith",
    "email": "john.smith@example.com",
    "imageUrl": "https://example.com/avatars/johnsmith.jpg",
    "region": "US"
  }
]

Response

Success

appCodestring
messagestring
isErrorboolean