<Intro>

<EndpointHeader />

<Description>

Updates the label on an inbound address. The address itself is fixed and cannot be changed.

</Description>

</Intro>

<Payload kind="request">

<Field name="label" type="nullable string">

<Description>

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.

</Description>

</Field>

</Payload>

<Payload kind="response">

<Field name="id" type="string" required>

<Description>

Inbound address ID.

</Description>

</Field>

<Field name="address" type="string" required>

<Description>

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

</Description>

</Field>

<Field name="label" type="nullable string" required>

<Description>

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

</Description>

</Field>

<Field name="created_at" type="string" required>

<Description>

When the inbound address was created.

</Description>

</Field>

<Field name="updated_at" type="string" required>

<Description>

When the inbound address was last updated.

</Description>

</Field>

</Payload>