POST
/inboxes/{inbox_id}/labelsCreate a label on an inbox
Creates a named, colored label on an inbox. Supply a name between 1 and 64 characters; names are unique per inbox, without regard to case, and color defaults to a random dashboard palette color when omitted.
- IdempotentThe SDK sends
Idempotency-Key, so a retried request is only applied once.
inbox_idstringrequired
The UUID of the inbox where you want to create the label. An email address is not accepted.
The label to create on the inbox.
namestringrequired
The name of the label. Max 64 characters. Leading and trailing whitespace is trimmed. Must not match another label on the inbox, compared without case.
colorstringoptional
The color of the label, as a `#RRGGBB` hex color. It is stored in uppercase. When omitted, a random color from the dashboard palette is used.
201Returns an object containing the ID of the created label.
objectstringrequired
Type of the response object.
idstringrequired
The ID of the label.
Error handling
The inbox_id path parameter must be a UUID for an inbox; an email address is not accepted. name is required, must contain 1 to 64 characters, and must not match another label name on the inbox without regard to case. If provided, color must be a #RRGGBB hex color.