Docs
DevelopersReferenceImages

API: Upload An Image

POST
/v1/itineraries/{id}/images

Stores an image for the itinerary, or for one of its days with day, and returns its address. Send the image itself as the body with Content-Type: image/jpeg, image/png or image/webp, up to 5 MB. The itinerary is not changed: save the address yourself. Only someone who can edit the itinerary can add images.

AuthorizationBearer <token>

A Travelyfe access token.

In: header

Path Parameters

id*string

The itinerary id (UUID).

Formatuuid

Query Parameters

day?string

The day id, for a day image.

Formatuuid

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/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

application/json

curl -X POST "https://example.com/v1/itineraries/497f6eca-6276-4993-bfeb-53cbbbba6f08/images" \  -H "Content-Type: application/octet-stream" \  -d 'string'
{  "url": "http://example.com"}