Create a contact
POST
/audiences/{audienceId}/contactsAutorização
AuthorizationToken Bearer · headerobrigatórioA BillionSend API key (bs_…).
Parâmetros de caminho
audienceIdstring<uuid>obrigatórioCorpo da requisição
obrigatórioapplication/jsonemailstring<email>obrigatórioBare email address (no display name); unique per team
first_namestringFirst name
last_namestringLast name
unsubscribedbooleanGlobal opt-out from all marketing sends
propertiesobjectFlat map of custom properties (string or number values)
segmentsobject[]Segments to add the contact to on creation
Mostrar propriedadesOcultar propriedades
Array de
objectidstring<uuid>obrigatóriotopicsobject[]Initial per-topic subscription choices
Mostrar propriedadesOcultar propriedades
Array de
objectidstring<uuid>obrigatóriosubscriptionstringobrigatórioValores permitidos:
opt_inopt_outRespostas
200
Contact created in the audience
objectstringobrigatórioValores permitidos:
contactidstring<uuid>obrigatório401
Missing, malformed, unknown or revoked API key
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório403
Plan limit reached
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório404
Not found
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório409
Contact already exists
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório422
Validation error
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório