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-runOptions
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 |
Related
| Name | Description |
|---|---|
| bird email domains delete | Delete a sending domain |
| bird email domains get | Get a sending domain |
| bird email domains list | List sending domains |
| bird email domains update | Update a sending domain's tracking settings and tracking domain. |
| bird email domains verify | Trigger domain verification |