Skip to main content
PATCH
Rename or subscribe a mailbox folder

Authorizations

Authorization
string
header
required

Your Inbound API key. Include it in the Authorization header as: Bearer

Path Parameters

id
string
required
folder
string
required

Folder path, URL-encoded as one segment (for example INBOX, Archive, Projects%2F2026 or Scopes%2F*%40example.com)

Body

path
string

New path. Subfolders move with the folder.

Required string length: 1 - 255
subscribed
boolean

Response

Response for status 200

path
string
required
name
string
required
specialUse
string · null · null
required
scopeId
string · null · null
required
subscribed
boolean
required
uidValidity
number
required
uidNext
number
required
highestModseq
number
required
total
number
required
unread
number
required