TextKitDocs

Create a segment

A segment is a saved, named filter over contacts (an audience; not an SMS message part).

POST/v1/segments

Body Parameters

  • namestring

    At most 80 characters.

  • descriptionstring

    At most 200 characters. Nullable.

  • matchall, any

    Default "all".

  • rulesarray of SegmentRule

    At most 10 items.

Details

It is evaluated when used, so it always reflects current contacts. Up to 100 segments, 10 rules each.

Responses

  • 201Segment

    The segment

  • 400Error

    Invalid rules, or the segment limit is reached

  • 401Error

    Missing, malformed, or revoked API key

  • 402Error

    Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged

  • 429Error

    Rate limit or quota exceeded

Response Fields

  • idstring

    Example: seg_a1B2c3D4e5F6.

  • objectsegment
  • namestring
  • descriptionstring

    Nullable.

  • matchall, any
  • rulesarray of SegmentRule
  • created_atstring (date-time)
  • updated_atstring (date-time)

Errors

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

  • 400

    Invalid rules, or the segment limit is reached

  • 401

    Missing, malformed, or revoked API key

  • 402

    Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged

  • 429

    Rate limit or quota exceeded