Sign inGet Started

Create an inbound address

POST
/v1/email/inbound-addresses
bird email inbound-addresses create --label 'Support mailbox'
Risposta201
{
  "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.

Payload della richiesta

label
string

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

Payload di risposta

id
string
obbligatorio

Inbound address ID.

address
string
obbligatorio

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

label
nullable string
obbligatorio

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

created_at
string
obbligatorio

When the inbound address was created.

updated_at
string
obbligatorio

When the inbound address was last updated.