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.

Anfrage-Nutzlast

label

nullable string

Your own label for this address. Pass null to clear it.

Antwort-Payload

string

erforderlich

Inbound address ID.

address

string

erforderlich

The address to forward your mailbox to. Minted by Bird when the inbound address is created.

label

nullable string

erforderlich

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

created_at

string

erforderlich

When the inbound address was created.

updated_at

string

erforderlich

When the inbound address was last updated.

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