Create a contact in an audience
POST
/audiences/{audienceId}/contactsAutorización
AuthorizationToken Bearer · headerobligatorioA BillionSend API key (bs_…).
Parámetros de ruta
audienceIdstring<uuid>obligatorioCuerpo de la solicitud
obligatorioapplication/jsonemailstring<email>obligatorioBare 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 propiedadesOcultar propiedades
Array de
objectidstring<uuid>obligatoriotopicsobject[]Initial per-topic subscription choices
Mostrar propiedadesOcultar propiedades
Array de
objectidstring<uuid>obligatoriosubscriptionstringobligatorioValores permitidos:
opt_inopt_outRespuestas
200
Contact created in the audience
objectstringobligatorioValores permitidos:
contactidstring<uuid>obligatorio401
Missing, malformed, unknown or revoked API key
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorio403
Plan limit reached
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorio404
Not found
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorio409
Contact already exists
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorio422
Validation error
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorio429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorio