Rename a folder

PATCH/api/v1/mailbox/folders/{folder}

Requires amailbox token— it acts as one mailbox holder, not as the organization.

folder is the id GET /folders returns. name is the new last segment; a nested folder keeps its parent, and RENAME carries its subfolders along. INBOX and the special-use folders (Sent, Drafts, Junk, Trash, Archive -- detected by SPECIAL-USE attribute and by well-known name) answer 409 cannot_rename_special_folder.

Parameters

Name	In	Type	Description
`folder`required	path	string

Request body

Request

PATCH/api/v1/mailbox/folders/{folder}

curl -X PATCH 'https://app.mailyte.com/api/v1/mailbox/folders/01JBT8XQ2M9WYC3K4F6R7S8T9V' \
  -H 'Authorization: Bearer MAILBOX_TOKEN'

const response = await fetch('https://app.mailyte.com/api/v1/mailbox/folders/01JBT8XQ2M9WYC3K4F6R7S8T9V', {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer MAILBOX_TOKEN',
  },
});
const { data } = await response.json();

import requests
response = requests.patch(
    "https://app.mailyte.com/api/v1/mailbox/folders/01JBT8XQ2M9WYC3K4F6R7S8T9V",
    headers={"Authorization": "Bearer MAILBOX_TOKEN"},
)
data = response.json()["data"]

<?php

$response = Http::withToken('MAILBOX_TOKEN')
    ->patch('https://app.mailyte.com/api/v1/mailbox/folders/01JBT8XQ2M9WYC3K4F6R7S8T9V');

$data = $response->json('data');

require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/mailbox/folders/01JBT8XQ2M9WYC3K4F6R7S8T9V")
request = Net::HTTP::Patch.new(uri)
request["Authorization"] = "Bearer MAILBOX_TOKEN"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

The key names its own organization, so no X-Organization-ID header is needed.

Response

Successful Response

Returned inside the standard envelope.

Errors

Status	When
`422`	Validation Error

Every status, with what causes it and what to do, is on the error reference.