Mailboxes

Create mailbox folder

Create a custom folder or subfolder for a mailbox. System folder names are reserved.

post/mailboxes/{id}/folders

Request

  • Base URL: https://shipmail.to/api/v1
  • URL: https://shipmail.to/api/v1/mailboxes/{id}/folders
  • 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

Idempotency-Keystring

Unique key for idempotent requests. Printable ASCII, 1-255 characters. The response is cached for 24 hours. A message send also derives the message ID from the key, so after the cache expires a retry on the same endpoint returns the message already sent, without comparing the body, for as long as that message exists.

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

Custom folder name. Reserved system folder names and path separators are rejected.

parent_idstring nullable required

Parent folder ID for a subfolder, or null to create a root folder.

Response

Mailbox folder created.

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.