Mailbox API

Update a mailbox folder

Changed on

Updates a folder unconditionally unless If-Match is supplied. Send If-Match with a prior ETag to reject stale edits.

patch/mailbox/folders/{folder_id}

Request

  • Base URL: https://app.sendmux.ai/api/v1
  • URL: https://app.sendmux.ai/api/v1/mailbox/folders/{folder_id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.sendmux.ai/oauth/authorize, token URL https://app.sendmux.ai/oauth/token, scopes: mailbox.settings.update)

Path parameters

folder_idstring required

Query parameters

mailbox_idstring

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.

Headers

If-Matchstring

Request body

namestring
parent_idstring nullable
sort_orderinteger

Response

Updated folder

oktrue required

Example response

{
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  }
}

Changes