Add or Update Segment Members

Add up to 1,000 people. A person is identified by their phone number (all formats of one number collapse to it: +91 98765 43210, 919876543210, national + countryCode) or, without a phone, by email — someone already in the segment is updated instead of added twice.

Phone numbers must be E.164 or come with countryCode; numbers that are not possible for their country are rejected per item in invalid (the rest are still added). Members are linked to your existing contact with the same phone / email, so contact fields work in templates. A segment holds at most 200,000 people.

Security:

  • The organisationId in the URL must match the organisation your JWT was issued for — requests for a different organisation fail with 401.
  • Requires CRM_ADMIN, ACCOUNT_OWNER, or CRM_BOT role; other roles receive 403.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Your organisation UUID (returned as org from the /token endpoint).

string
required

A segment id (segmentId from the list or create response).

Body Params
members
array of objects
required

1–1000 people. Each needs a phone or an email; a person already in the segment (same number / email) is updated, not added twice.

members*
boolean
Defaults to true

For people already in the segment: true (default) merges the new attributes into the stored ones; false replaces them.

Responses

400

Bad request — not a list, more than 1,000, or the segment is full

401

Unauthorized — invalid/expired JWT or organisation ID does not match the token

403

Forbidden — role not permitted

404

Segment not found in your organisation

429

Too many requests

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json