Documentation
Sign inGet started
Inizia ora
Guide
Riferimento API
SDK e CLI
Knowledge Base
Changelog

Update an inbound address

PATCH
/v1/email/inbound-addresses/{inbound_address_id}
curl -X PATCH "https://us1.platform.bird.com/v1/email/inbound-addresses/{inbound_address_id}" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "label": "Sales mailbox"
  }'
Updates the label on an inbound address. The address itself is fixed and cannot be changed.
Payload della richiesta
label
nullable string
Your own label for this address. Pass null to clear it.
Payload di risposta
id
string
obbligatorio
Inbound address ID.
address
string
obbligatorio
The address to forward your mailbox to. Minted by Bird 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.