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

Create a contact in an audience

POST/audiences/{audienceId}/contacts
Autorisation
AuthorizationJeton Bearer · headerrequis

A BillionSend API key (bs_…).

Paramètres de chemin
audienceIdstring<uuid>requis
Corps de la requête
requisapplication/json
emailstring<email>requis

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

Afficher les propriétés
Tableau de object
idstring<uuid>requis
topicsobject[]

Initial per-topic subscription choices

Afficher les propriétés
Tableau de object
idstring<uuid>requis
subscriptionstringrequis
Valeurs autorisées :opt_inopt_out
Réponses
200

Contact created in the audience

objectstringrequis
Valeurs autorisées :contact
idstring<uuid>requis
401

Missing, malformed, unknown or revoked API key

statusCodenumberrequis
namestringrequis
messagestringrequis
403

Plan limit reached

statusCodenumberrequis
namestringrequis
messagestringrequis
404

Not found

statusCodenumberrequis
namestringrequis
messagestringrequis
409

Contact already exists

statusCodenumberrequis
namestringrequis
messagestringrequis
422

Validation error

statusCodenumberrequis
namestringrequis
messagestringrequis
429

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

statusCodenumberrequis
namestringrequis
messagestringrequis
Essayer
Serveur
Autorisation
Paramètres
Corpsapplication/json
Requête
curl -X POST 'https://api.billionsend.com/audiences/497f6eca-6276-4993-bfeb-53cbbbba6f08/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"
    }
  ]
}'
Réponse
{
  "object": "contact",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

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