Pular para o conteúdo
Esc
↑↓navegar↵abrir⌘Jpré-visualizar

Create a segment

POST/segments
Autorização
AuthorizationToken Bearer · headerobrigatório

A BillionSend API key (bs_…).

Corpo da requisição
obrigatórioapplication/json
namestringobrigatório
comprimento mín. 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
Mostrar propriedades
matchstringobrigatório
Valores permitidos:allany
conditionsobject[]obrigatório
máx. 50 itens
Mostrar propriedades
Array de object
fieldstringobrigatório
opstringobrigatório
valuestring | nullobrigatório
comprimento máx. 500
Respostas
200

Segment created

objectstringobrigatório
Valores permitidos:segment
idstring<uuid>obrigatório
namestringobrigatório
domain_idstring<uuid> | nullobrigatório

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

filterSegmentFilter | nullobrigatório
Mostrar propriedades
matchstringobrigatório
Valores permitidos:allany
conditionsobject[]obrigatório
máx. 50 itens
Mostrar propriedades
Array de object
fieldstringobrigatório
opstringobrigatório
valuestring | nullobrigatório
comprimento máx. 500
created_atstringobrigatório
401

Missing, malformed, unknown or revoked API key

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
403

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

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
422

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

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
429

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

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
Experimentar
Servidor
Autorização
Corpoapplication/json
Requisição
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"
      }
    ]
  }
}'
Resposta
{
  "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"
}

Esta página foi útil?