Update preview background file

PUT /data/preview-background-files/{instance_id}
Jwt authorization

Update a preview background file with data provided in the request body. JSON format is expected. Names must be unique. If is_default is set to true, resets other defaults.

Path parameters

  • instance_id string(uuid) Required
application/json

Body Required

  • name string
  • is_default boolean

Responses

  • 200 application/json

    Preview background file updated successfully

    Hide response attributes Show response attributes object
    • id string(uuid)
    • name string
    • is_default boolean
    • created_at string(date-time)
    • updated_at string(date-time)
  • 400

    Invalid data format or name already exists

PUT /data/preview-background-files/{instance_id} 
curl \
 --request PUT 'http://api.example.com/data/preview-background-files/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"name":"updated_background_file_name","is_default":true}'
Request examples 
{
  "name": "updated_background_file_name",
  "is_default": true
}
Response examples (200) 
{
  "id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "name": "updated_background_file_name",
  "is_default": true,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T11:00:00Z"
}