Mailboxes

Rename mailbox folder

Rename a custom mailbox folder. System folders cannot be renamed.

patch/mailboxes/{id}/folders/{folder_id}

Request

  • Base URL: https://shipmail.to/api/v1
  • URL: https://shipmail.to/api/v1/mailboxes/{id}/folders/{folder_id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://shipmail.to/api/auth/oauth2/authorize, token URL https://shipmail.to/api/auth/oauth2/token)

Headers

X-Shipmail-Organizationstring

OAuth access tokens only. The organization ID this request acts on. Required when the OAuth connection was approved for several organizations (400 validation_error without it); optional with one. An organization the connection was not approved for returns 403 authorization_error. Ignored for API keys, which belong to one organization.

Request body

namestring required

New custom folder name. Reserved system folder names and path separators are rejected.

Response

Mailbox folder renamed.

object'mailbox_folder' required
idstring required
namestring required
parent_idstring nullable required

Parent folder ID for subfolders, or null for a root folder.

rolestring nullable required
kind'custom' | 'system' required
total_emailsinteger required
unread_emailsinteger required
unread_threadsinteger required
sort_orderinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.