Skip to main content
POST
email.folder.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
inbox
string
required

The owned connected mailbox address.

Required string length: 1 - 320
name
string
required

Folder name.

Required string length: 1 - 256
parentRef
string

The ref returned by email.folder.get.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
textColor
string

Text color, where supported.

Required string length: 1 - 32
backgroundColor
string

Background color, where supported.

Required string length: 1 - 32

Response

The result

name
string
required

Folder name.

textColor
string

Text color, where supported.

backgroundColor
string

Background color, where supported.

parentRef
string

The ref returned by email.folder.get.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
totalCount
integer
Required range: 0 <= x <= 9007199254740991
unreadCount
integer
Required range: 0 <= x <= 9007199254740991
system
boolean

Whether this is a system folder.

ref
string

Reference to what this call created. Pass it as ref to email.folder.get.