Contatos

Alcançar contatos

A página Contatos

O que um contato contém

Propriedades de contato

• A chave é o nome usado para referenciar o valor, como plan_tier. Ela deve usar letras minúsculas e começar com uma letra (^[a-z][a-z0-9_]*$), e não pode ser alterada após a criação.
• O tipo é um destes: string, number, boolean ou datetime, e também não pode ser alterado após a criação. Um datetime aceita um registro de data e hora RFC 3339 com um deslocamento explícito, como 2026-01-15T11:30:00+02:00, que normalizamos para UTC com precisão de segundos. Assim, esse valor é armazenado e retornado como 2026-01-15T09:30:00Z. Uma data sem horário é rejeitada. O painel identifica esses tipos como Texto, Número, Verdadeiro / falso e Data e hora.
• O valor de fallback é o valor lido para um contato que não tem um valor próprio. Assim, se plan_tier estiver ausente, o resultado pode ser free em vez de um valor em branco.

Importar e sincronizar contatos

const contact = await bird.contacts.create({
  email: "jane@acme.com",
  first_name: "Jane",
});
console.log(contact.id); // "con_…"

contact = client.contacts.create(email="jane@acme.com", first_name="Jane")
print(contact.id, contact.email)

contact, err := client.Contacts.Create(context.Background(), bird.ContactCreateParams{
	Email:     bird.Ptr("jane@acme.com"),
	FirstName: bird.Ptr("Jane"),
})
if err != nil {
	log.Fatal(err)
}
fmt.Println(contact.Id)

$contact = $bird->contacts->create(
    (new ContactCreateRequest())
        ->setEmail('jane@acme.com')
        ->setFirstName('Jane'),
);
echo $contact->getId(); // "con_…"

bird contacts create alice@acme.com \
  --first-name Alice \
  --last-name Anderson \
  --phone-number +31612345678

{
  "name": "contacts_create",
  "arguments": {
    "email": "alice@acme.com",
    "first_name": "Alice",
    "last_name": "Anderson",
    "phone_number": "+31612345678"
  }
}

curl -X POST "https://{region}.platform.bird.com/v1/contacts" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "alice@acme.com",
    "phone_number": "+31612345678",
    "first_name": "Alice",
    "last_name": "Anderson"
  }'

{
  "data": [
    {
      "contact_id": "con_01ky7q5t51echr7mqj5c08423b",
      "entry": { "email": "alex@example.com", "phone_number": null, "external_id": null },
      "matched_on": "email",
      "status": "updated"
    },
    {
      "contact_id": "con_01ky7q6mxdfhe86c9dqyt866pz",
      "entry": { "email": "jamie@example.com", "phone_number": null, "external_id": null },
      "matched_on": null,
      "status": "created"
    },
    {
      "contact_id": "con_01ky7q7rv9e9pt4vkr0w0gxq5e",
      "entry": { "email": "casey@example.com", "phone_number": null, "external_id": "user_2214" },
      "matched_on": "external_id",
      "status": "updated"
    }
  ]
}

Excluir um contato

Próximos passos

• Públicos: agrupe contatos em listas reutilizáveis
• Supressões: a lista do espaço de trabalho com os endereços para os quais não entregamos mensagens, separada dos seus contatos
• Envio em lote: alcance vários destinatários em uma única chamada, com até 100 mensagens por solicitação
• CLI: automatize contatos, propriedades e públicos por script com o comando bird
• Referência da API: os esquemas completos de solicitações e respostas