Aller au contenu
Esc
↑↓naviguer↵ouvrir⌘Japerçu

Create a segment

POST/segments
Autorisation
AuthorizationJeton Bearer · headerrequis

A BillionSend API key (bs_…).

Corps de la requête
requisapplication/json
namestringrequis
longueur min 1
domain_idstring<uuid> | null

BillionSend 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 | null
Afficher les propriétés
matchstringrequis
Valeurs autorisées :allany
conditionsobject[]requis
max 50 éléments
Afficher les propriétés
Tableau de object
fieldstringrequis
opstringrequis
valuestring | nullrequis
longueur max 500
Réponses
200

Segment created

objectstringrequis
Valeurs autorisées :segment
idstring<uuid>requis
namestringrequis
domain_idstring<uuid> | nullrequis

BillionSend extension: the domain the segment is bound to; null for a team-wide segment

filterSegmentFilter | nullrequis
Afficher les propriétés
matchstringrequis
Valeurs autorisées :allany
conditionsobject[]requis
max 50 éléments
Afficher les propriétés
Tableau de object
fieldstringrequis
opstringrequis
valuestring | nullrequis
longueur max 500
created_atstringrequis
401

Missing, malformed, unknown or revoked API key

statusCodenumberrequis
namestringrequis
messagestringrequis
403

A key held to one domain bound this to another domain, or unbound it

statusCodenumberrequis
namestringrequis
messagestringrequis
422

Validation error, or a domain_id that is not one of your domains

statusCodenumberrequis
namestringrequis
messagestringrequis
429

Over the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumberrequis
namestringrequis
messagestringrequis
Essayer
Serveur
Autorisation
Corpsapplication/json
Requête
curl -X POST 'https://api.billionsend.com/segments' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "domain_id": "b2f7354f-b74d-4332-ab10-1a5e3c56466c",
  "filter": {
    "match": "all",
    "conditions": [
      {
        "field": "string",
        "op": "string",
        "value": "string"
      }
    ]
  }
}'
Réponse
{
  "object": "segment",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "domain_id": "b2f7354f-b74d-4332-ab10-1a5e3c56466c",
  "filter": {
    "match": "all",
    "conditions": [
      {
        "field": "string",
        "op": "string",
        "value": "string"
      }
    ]
  },
  "created_at": "string"
}

Cette page vous a-t-elle été utile ?