Rename a document folder

PATCH/v1/document-folders/{folderId}

Renames one of a trip's document folders. Undo with POST /changes/{changeId}/revert.

Permissions: documents:write · Kind: write · Cost: 1 unit · MCP tool rename_document_folder

Undoable: the response carries Bymundi-Change-Id; revert it with POST /v1/changes/{changeId}/revert.

Path parameters

Field	Type	Required	Description
`folderId`	uuid	yes

Body

Field	Type	Required	Description
`name`	string	yes	As travelers will see it, e.g. 'Flights', 'Hotels', 'Insurance'. max 200 chars

Response `200`

Field	Type	Required	Description
`object`	"document_folder"	yes
`id`	uuid	yes
`tripId`	uuid	yes
`name`	string	yes
`documentCount`	integer	yes	Ready documents filed in it. ≥ 0
`createdAt`	string	yes

Errors

Errors are problem details. Besides the refusals described above, any call like this one can return:

invalid_request — Invalid request
unauthorized — Missing or invalid API key
insufficient_scope — Missing permission
rate_limited — Rate limit reached
not_found — Not found
idempotency_key_reused — Idempotency-Key reused
request_in_progress — Request in progress

Examples

curl

curl -X PATCH https://api.bymundi.com/v1/document-folders/$FOLDER_ID \ -H "Authorization: Bearer $BYMUNDI_KEY" \ -H "Content-Type: application/json" \ -H "Idempotency-Key: $(uuidgen)" \ -d '{"name":"string"}'

JavaScript

Python

import os, uuid, requests res = requests.patch( f"https://api.bymundi.com/v1/document-folders/{folderId}", headers={"Authorization": f"Bearer {os.environ['BYMUNDI_KEY']}", "Idempotency-Key": str(uuid.uuid4())}, json={"name":"string"}, ) res.raise_for_status() data = res.json()

Rename a document folder

#Path parameters

#Body

#Response 200

#Errors

Path parameters

Body

Response `200`

Errors