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

Retrieve a contact

GET/contacts/{id}
Autorização
AuthorizationToken Bearer · headerobrigatório

A BillionSend API key (bs_…).

Parâmetros de caminho
idstringobrigatório
comprimento mín. 1
Respostas
200

Contact

idstring<uuid>obrigatório
emailstringobrigatório
first_namestring | nullobrigatório
last_namestring | nullobrigatório
created_atstringobrigatório
unsubscribedbooleanobrigatório

Opt-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ório

BillionSend 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 propriedades
Array de object
domain_idstring<uuid> | nullobrigatório

Null when the domain has since been deleted from the team

namestringobrigatório

The domain's name

unsubscribed_atstringobrigatório
verification_statusstring | nullobrigatório

BillionSend extension: the verdict of the contact's last deep verification (POST /verifications); null while it was never verified

Valores permitidos:validinvalidriskycatchallroledisposableunknownnull
verified_atstring | nullobrigatório

When the last deep verification finished; null while never verified

objectstringobrigatório
Valores permitidos:contact
propertiesobjectobrigatório
401

Missing, malformed, unknown or revoked API key

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
404

Not found

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
Parâmetros
Requisição
curl -X GET 'https://api.billionsend.com/contacts/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Resposta
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "email": "string",
  "first_name": "string",
  "last_name": "string",
  "created_at": "string",
  "unsubscribed": true,
  "unsubscribed_domains": [
    {
      "domain_id": "b2f7354f-b74d-4332-ab10-1a5e3c56466c",
      "name": "string",
      "unsubscribed_at": "string"
    }
  ],
  "verification_status": "valid",
  "verified_at": "string",
  "object": "contact",
  "properties": {
    "property1": {
      "type": "string",
      "value": "string"
    },
    "property2": {
      "type": "string",
      "value": "string"
    }
  }
}

Esta página foi útil?