Update an inbound address
PATCH
/v1/email/inbound-addresses/{inbound_address_id}
bird email inbound-addresses update <inbound-address-id> \
--label 'Sales mailbox'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"
}'Response200
{
"id": "ina_01krdgeqcxet5s7t44vh8rt9mg",
"address": "a1b2c3@inbound.eu.bird.com",
"label": "Support mailbox"
}
Updates the label on an inbound address. The address itself is fixed and cannot be changed.
Parameters
inbound_address_id
string
Inbound address identifier. Starts with ina_.
Request Payload
label
nullable string
Your own label for this address, typically the source mailbox it maps to. Send null to clear it. Omit the field to leave it unchanged.
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.