Docs
DevelopersReferenceDocuments

API: Rename A Document

PATCH
/v1/itineraries/{id}/documents/{documentId}

Changes a document's name or kind. Requires Travelyfe Pro.

AuthorizationBearer <token>

A Travelyfe access token.

In: header

Path Parameters

id*string

The itinerary id (UUID).

Formatuuid
documentId*string

The document id.

Header Parameters

Travelyfe-Itinerary-Shape?"clean"

Send clean on every request that reads or writes an itinerary. It is the shape this reference documents.

Value in

  • "clean"

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/itineraries/497f6eca-6276-4993-bfeb-53cbbbba6f08/documents/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "name": "string",  "kind": "string",  "mimeType": "string",  "size": 0,  "url": "http://example.com"}