Add a contact to a static segment, referenced by contact id or email (contact), or many at once: contact_ids or emails, up to 1,000 in one call. Send exactly one of the three. The operation is idempotent — adding a contact that's already a member is a no-op that keeps its per-segment subscription and still succeeds. Each contact that joins gets a segment.joined webhook and an activity row. A list is checked first: the first contact that isn't one of yours is a 404 naming it (details), and nobody is added. One contact answers 201 with its membership; a list answers 200 with each listed contact's membership in the order sent and added, how many joined now. Adding a list counts against a limit of 30 bulk contact edits a minute per workspace by default (a 429 added nobody; retry after Retry-After). For more than 1,000 contacts, call it once per 1,000. See the current members with List segment members. Requires the segments:write capability.
Parameters1 field
Field
Type
Description
idrequired
string · path
—
Request body4 fields
Field
Type
Description
contact
string
One contact: its id (`con_…`) or email.
contact_ids
string[]
Many contacts of this workspace by id (`con_…`), up to 1,000.
emails
string[]
Many contacts of this workspace by email address, up to 1,000.
subscribed
boolean
A new member's per-segment subscription (default true). A contact that is already a member keeps its own.