Mail

Rename a mail folder

Renames or moves a folder.

PATCH /v1/folders/:id

Permission

The key must be granted mail.folders.write

A key without it gets 403 insufficient_scope, with the missing permission named in details.

Path parameters

Field Type Description
id required string The folder to change.

Request body

Send only what changes. Fields you omit are left alone.

Field Type Description
name string A new name. Renaming does not move the messages.
parent_id string Moves the folder, and everything in it, under another.

Request

curl https://api.veruapis.com/v1/folders/:id \
  -X PATCH \
  -H "Authorization: Bearer vak_live_..." \
  -H "Idempotency-Key: $(uuidgen)"

Idempotency-Key is required on every write. Retrying with the same key returns the original response rather than repeating the operation, so a timeout is something you retry rather than something you investigate.

Response

{
  "data": { ... },
  "meta": { "request_id": "req_01j8z9...", "timestamp": "2026-09-02T10:00:00Z" }
}

A worked example for this endpoint has not been written yet.

Errors

Every failure uses the same shape, with a stable string code you can branch on. See the error reference.

Related

PATCH /v1/folders/:id

id
Sends this body to your own workspace, for real. Edit it before running.