Retrieve a contact
/contacts/{id}AuthorizationToken Bearer · headerobrigatórioA BillionSend API key (bs_…).
idstringobrigatórioContact
idstring<uuid>obrigatórioemailstringobrigatóriofirst_namestring | nullobrigatóriolast_namestring | nullobrigatóriocreated_atstringobrigatóriounsubscribedbooleanobrigatórioOpt-out from every marketing send of the team, whichever domain sends. A recipient's own unsubscribe never sets it: that is recorded for the domain whose email carried the link (see unsubscribed_domains).
unsubscribed_domainsobject[]obrigatórioBillionSend extension: the domains this contact unsubscribed from through a link in their email. Marketing sends from those domains skip the contact; other domains still reach them. The team-wide opt-out is unsubscribed, not an entry here. Remove an entry with DELETE /unsubscribes/{id}.
Mostrar propriedadesOcultar propriedades
objectdomain_idstring<uuid> | nullobrigatórioNull when the domain has since been deleted from the team
namestringobrigatórioThe domain's name
unsubscribed_atstringobrigatórioverification_statusstring | nullobrigatórioBillionSend extension: the verdict of the contact's last deep verification (POST /verifications); null while it was never verified
validinvalidriskycatchallroledisposableunknownnullverified_atstring | nullobrigatórioWhen the last deep verification finished; null while never verified
objectstringobrigatóriocontactpropertiesobjectobrigatórioMissing, malformed, unknown or revoked API key
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatórioNot found
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatórioOver the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório