Documentation
Sign inGet started
Começar
Guias
Referência de API
SDKs e CLI
Base de conhecimento
Changelog

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.
Corpo da requisição
label
string
Your own label for this address, typically the source mailbox it maps to.
Payload de resposta
id
string
obrigatório
Inbound address ID.
address
string
obrigatório
The address to forward your mailbox to. Minted by Bird when the inbound address is created.
label
nullable string
obrigatório
Your own label for this address, typically the source mailbox it maps to. Null when unset.
created_at
string
obrigatório
When the inbound address was created.
updated_at
string
obrigatório
When the inbound address was last updated.