PATCH
/inboxes/{inbox_id}/labels/{label_id}Update an inbox label
Updates the name or color of an inbox label. Supply only the fields you want to change; omitted fields keep their current values, and a new name must remain unique on the inbox without regard to case.
- IdempotentThe SDK sends
Idempotency-Key, so a retried request is only applied once.
inbox_idstringrequired
The UUID of the inbox containing the label. An email address is not accepted.
label_idstringrequired
The UUID of the label to update.
The label fields to update. Omitted fields keep their current values.
namestringoptional
A new name for the label. Max 64 characters. Leading and trailing whitespace is trimmed. Must not match another label on the inbox, compared without case.
colorstringoptional
A new color for the label, as a `#RRGGBB` hex color. It is stored in uppercase.
200Returns an object containing the ID of the updated label.
objectstringrequired
Type of the response object.
idstringrequired
The ID of the updated label.
Error handling
The inbox_id path parameter and label_id path parameter must be UUIDs for the target inbox and label. If provided, name must contain 1 to 64 characters and must not match another label name on the inbox without regard to case; color must be a #RRGGBB hex value.