Skip to main content
PATCH
Update a mailbox folder

Authorizations

Authorization
string
header
required

Sendmux API key. Use a root API key for Management API routes, or a mailbox credential for Mailbox API routes. Obtain keys from the dashboard under API Keys.

Headers

If-Match
string

Path Parameters

folder_id
string
required

Query Parameters

mailbox_id
string

Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.

Body

application/json
name
string
parent_id
string | null
sort_order
integer

Response

Updated folder

meta
object
required
ok
enum<boolean>
required
Available options:
true
data
object
required