Create a segment
/segmentsAuthorizationBearer token · headerrequiredA BillionSend API key (bs_…).
application/jsonnamestringrequireddomain_idstring<uuid> | nullBillionSend extension: id of one of your domains. A broadcast to this segment must then be sent from that domain (422 otherwise), so an audience is never mailed under another brand or against another brand's opt-outs. null or omitted: a segment of the whole team, sendable from any domain. On update, null makes the segment a team-wide one again.
filterSegmentFilter | nullShow propertiesHide properties
matchstringrequiredallanyconditionsobject[]requiredShow propertiesHide properties
objectfieldstringrequiredopstringrequiredvaluestring | nullrequiredSegment created
objectstringrequiredsegmentidstring<uuid>requirednamestringrequireddomain_idstring<uuid> | nullrequiredBillionSend extension: the domain the segment is bound to; null for a team-wide segment
filterSegmentFilter | nullrequiredShow propertiesHide properties
matchstringrequiredallanyconditionsobject[]requiredShow propertiesHide properties
objectfieldstringrequiredopstringrequiredvaluestring | nullrequiredcreated_atstringrequiredMissing, malformed, unknown or revoked API key
statusCodenumberrequirednamestringrequiredmessagestringrequiredA key held to one domain bound this to another domain, or unbound it
statusCodenumberrequirednamestringrequiredmessagestringrequiredValidation error, or a domain_id that is not one of your domains
statusCodenumberrequirednamestringrequiredmessagestringrequiredOver the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberrequirednamestringrequiredmessagestringrequired