Skip to main content
PATCH
/
mailbox
/
folders
/
{folder_id}
Update a mailbox folder
curl --request PATCH \
  --url https://app.sendmux.ai/api/v1/mailbox/folders/{folder_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "parent_id": "<string>",
  "sort_order": 123
}
'
{
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "data": {
    "id": "<string>",
    "name": "<string>",
    "parent_id": "<string>",
    "role": "<string>",
    "sort_order": 123,
    "total_messages": 123,
    "unread_messages": 123,
    "can_add_items": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.sendmux.ai/llms.txt

Use this file to discover all available pages before exploring further.

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

Body

application/json
name
string
parent_id
string | null
sort_order
integer

Response

Updated folder

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