POST /pictures/preview-background-files/{instance_id}
Jwt authorization

Main resource to add a preview background file. It stores the preview background file and generates a rectangle thumbnail.

Path parameters

  • instance_id string(uuid) Required

    Preview background file unique identifier

Responses

  • 201 application/json

    Preview background file added successfully

    Hide response attributes Show response attributes object
    • id string(uuid)

      Preview background file unique identifier

    • extension string

      File extension

    • file_size integer

      File size in bytes
  • 400

    Wrong file format or error saving file

POST /pictures/preview-background-files/{instance_id} 
curl -X POST "http://api.example.com/pictures/preview-background-files/a24a6ea4-ce75-4665-a070-57453082c25" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"
import requests

url = "http://api.example.com/pictures/preview-background-files/a24a6ea4-ce75-4665-a070-57453082c25"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Accept": "application/json"
}
params = {}
payload = None

response = requests.post(
    url,
    headers=headers,
    params=params,
    json=payload
)

response.raise_for_status()

if response.content:
    print(response.json())
curl \
 --request POST 'http://api.example.com/pictures/preview-background-files/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"
Response examples (201) 
{
  "id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "extension": "hdr",
  "file_size": 2048000
}