TravelyfeHelp
开发者ReferenceDocuments

Store A Document's File

PUT
/v1/itineraries/{id}/documents/{documentId}/file

Stores the sealed bytes of a document the app is adding, before its details are saved. Returns the storagePath to save with it. Documents are encrypted on the traveller's own devices before upload; the server only ever holds the sealed file and never its contents. Requires Travelyfe Pro.

Only available to the Travelyfe apps. Tokens issued to other apps receive forbidden.

AuthorizationBearer <token>

A Travelyfe access token.

In: header

Path Parameters

id*string

The itinerary id (UUID).

Formatuuid
documentId*string

The document id.

Request Body

application/octet-stream

TypeScript Definitions

Use the request body type in TypeScript.

body*file
Formatbinary

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/v1/itineraries/497f6eca-6276-4993-bfeb-53cbbbba6f08/documents/string/file" \  -H "Content-Type: application/octet-stream" \  -d 'string'
{  "storagePath": "string"}