Documentation
Sign inGet started

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.
Cuerpo de la solicitud
label
string
Your own label for this address, typically the source mailbox it maps to.
Carga de respuesta
id
string
obligatorio
Inbound address ID.
address
string
obligatorio
The address to forward your mailbox to. Minted by Bird when the inbound address is created.
label
nullable string
obligatorio
Your own label for this address, typically the source mailbox it maps to. Null when unset.
created_at
string
obligatorio
When the inbound address was created.
updated_at
string
obligatorio
When the inbound address was last updated.