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

Antwort200

{
  "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.

Parameter

inbound_address_id

string

Inbound address identifier. Starts with ina_.

Anfrage-Nutzlast

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.

Antwort-Payload

string

erforderlich

Inbound address ID.

address

string

erforderlich

The address to forward your mailbox to. We generate it 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.

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

Antwort200

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