Documentation
Sign inGet started

bird email domains create

Usage

Code example
bird email domains create <domain> [flags]

Description

Register a sending domain and return the DNS records to configure.
The domain starts in "pending" status. Add the returned DNS records at your DNS provider, then run "bird email domains verify <id>" to check them.
Build the request from the <domain> argument, a JSON DomainCreate 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.

Procedure

Step 1 of 2 of "Register and verify a sending domain". Next: bird email domains verify.

Examples

Code example
# print the body shape (no credentials needed)
bird email domains create --example

# the body it prints:
Code example
{
  "domain": "mail.acme.com"
}
Code example
# add a sending domain
bird email domains create mail.acme.com

# preview the request without creating
bird email domains create mail.acme.com --dry-run

Options

Request

NameDescription
--body-fileRead the JSON request body from this file; "-" reads stdin
--examplePrint a complete example request body, then exit
--dry-runPrint the resolved request without sending it, then exit
--idempotency-keyDeduplication key; a retry with the same key won't act twice

Options

NameDescription
--response-schemaPrint the fields this command returns, then exit
NameDescription
bird email domains deleteDelete a sending domain
bird email domains getGet a sending domain
bird email domains listList sending domains
bird email domains updateUpdate a sending domain's tracking settings and tracking domain.
bird email domains verifyTrigger domain verification