Labels and filing rules

Create a label, optionally with auto-filing rules

Create a folder-style label. Set skip_inbox: true to make it a bucket: received mail that gets this label (from a rule, from a reply to a conversation sent with the label, or added by hand) is archived so it appears only in the label, never the Inbox. Optional rules file new sent or received mail automatically: every condition set on a rule must match (inbox_id, direction, and case-insensitive from/to/subject substrings). Set apply_to_existing to file retained mail too.

post/labels

Request

Request body

namestring required
colorstring required
skip_inboxboolean required
apply_to_existingboolean required

Response

Successful response

idstring required
namestring required
colorstring required
skipInboxboolean required
totalCountinteger required
unreadCountinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.