Create an inbound address

POST

/v1/email/inbound-addresses

bird email inbound-addresses create --label 'Support mailbox'

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"
  }'

Response201

{
  "id": "ina_01krdgeqcxet5s7t44vh8rt9mg",
  "address": "mfzxq2lom5uxi3lb@eu1.inbound.bird.com",
  "label": "Support mailbox"
}

Creates a new inbound address. Forward a real mailbox to the returned address, and every message sent there arrives as a received email.

The address works as soon as it is returned and requires no verification step.

An optional label records which source mailbox the address maps to.

Request Payload

label

string

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

Response Payload

id

string

required

Inbound address ID.

address

string

required

The address to forward your mailbox to. We generate it when the inbound address is created.

label

nullable string

required

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

created_at

string

required

When the inbound address was created.

updated_at

string

required

When the inbound address was last updated.

Continue with the documentation, guides and examples for this topic.

Try the practice and get an implementation brief

bird email inbound-addresses create --label 'Support mailbox'

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"
  }'

Response201

{
  "id": "ina_01krdgeqcxet5s7t44vh8rt9mg",
  "address": "mfzxq2lom5uxi3lb@eu1.inbound.bird.com",
  "label": "Support mailbox"
}

Create an inbound address

Request Payload

Response Payload

Related resources