Skip to content
SendSignal Docs

Segments

A segment is a named list of contacts (“beta users”, “newsletter”, “churn risk”) that you manage explicitly and target with broadcasts via segment_id.

Terminal window
# Create
curl https://api.sendsignal.dev/segments \
  -H "Authorization: Bearer ss_..." -H "Content-Type: application/json" \
  -d '{"name": "Beta users"}'


# Add / remove a contact
curl -X POST   https://api.sendsignal.dev/contacts/{contactId}/segments/{segmentId} -H "Authorization: Bearer ss_..."
curl -X DELETE https://api.sendsignal.dev/contacts/{contactId}/segments/{segmentId} -H "Authorization: Bearer ss_..."
  • GET /segments: list segments.
  • GET /contacts/{id}/segments: a contact’s memberships.
  • DELETE /segments/{id}: delete the segment (contacts themselves are untouched).

A broadcast targeting a segment mails its members, minus anyone unsubscribed or suppressed. Automations can also add contacts to segments with the add_to_segment step.