bird contacts create

Usage

Contoh kode

bird contacts create <email> [flags]

Description

Create a contact by email address.

The email is the contact's unique key in the workspace; a duplicate email or external-id returns 409. --data keys must be contact properties you defined with "bird email contact-properties create".

Build the request from the <email> argument and flags, a JSON ContactCreateRequest body via --body-file ("-" reads stdin), or both — an inline value overrides the matching body field. Run --example to print a ready-to-edit body, or --dry-run to print the resolved request without sending it.

Examples

Contoh kode

# print the body shape (no credentials needed)
bird contacts create --example

# the body it prints:

Contoh kode

{
  "email": "alice@acme.com",
  "first_name": "Alice",
  "last_name": "Anderson"
}

Contoh kode

# create a contact
bird email contacts create jane@acme.com --first-name Jane

# preview the request without creating
bird email contacts create jane@acme.com --dry-run

Options

Contact

Name	Description
--first-name	The contact's first name
--last-name	The contact's last name
--external-id	Your own identifier for this contact; unique within the workspace when set
--data	Custom property values as a JSON object, e.g. --data '{"plan":"pro"}'

Request

Name	Description
--body-file	Read the JSON request body from this file; "-" reads stdin
--example	Print a complete example request body, then exit
--dry-run	Print the resolved request without sending it, then exit
--idempotency-key	Deduplication key; a retry with the same key won't act twice

Options

Name	Description
--response-schema	Print the fields this command returns, then exit

Name	Description
bird contacts batch	Create or update many contacts in one request, matched by email.
bird contacts delete	Delete a contact
bird contacts get	Get a contact
bird contacts list	List contacts
bird contacts update	Update a contact's name, email, external-id, or custom data.