Create an inbound address

POST

/v1/email/inbound-addresses

curl -X POST "https://us1.platform.bird.com/v1/email/inbound-addresses" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "label": "Support mailbox"
  }'

Mints a new inbound address. Forward a real mailbox to the returned address and Bird parses every message it receives into a received email. An optional label records which source mailbox the address maps to.

Anfrage-Nutzlast

label

string

Your own label for this address, typically the source mailbox it maps to.

Antwort-Payload

string

erforderlich

Inbound address ID.

address

string

erforderlich

The address to forward your mailbox to. Minted by Bird when the inbound address is created.

label

nullable string

erforderlich

Your own label for this address, typically the source mailbox it maps to. Null when unset.

created_at

string

erforderlich

When the inbound address was created.

updated_at

string

erforderlich

When the inbound address was last updated.

curl -X POST "https://us1.platform.bird.com/v1/email/inbound-addresses" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "label": "Support mailbox"
  }'