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

Create a contact

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

A BillionSend API key (bs_…).

Corpo da requisição
obrigatórioapplication/json
emailstring<email>obrigatório

Bare email address (no display name); unique per team

first_namestring

First name

last_namestring

Last name

unsubscribedboolean

Global opt-out from all marketing sends

propertiesobject

Flat map of custom properties (string or number values)

segmentsobject[]

Segments to add the contact to on creation

Mostrar propriedades
Array de object
idstring<uuid>obrigatório
topicsobject[]

Initial per-topic subscription choices

Mostrar propriedades
Array de object
idstring<uuid>obrigatório
subscriptionstringobrigatório
Valores permitidos:opt_inopt_out
Respostas
200

Contact created

objectstringobrigatório
Valores permitidos:contact
idstring<uuid>obrigatório
401

Missing, malformed, unknown or revoked API key

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
403

Plan limit reached

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
404

Unknown segment or topic

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
409

Contact already exists

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
422

Validation error

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/contacts' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "email": "user@example.com",
  "first_name": "string",
  "last_name": "string",
  "unsubscribed": true,
  "properties": {
    "property1": null,
    "property2": null
  },
  "segments": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  ],
  "topics": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "subscription": "opt_in"
    }
  ]
}'
Resposta
{
  "object": "contact",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Esta página foi útil?