ioio.tv APIs

# Presets Update

API call format

PUT /broker/presets/guid              //Use token autorization
PUT /broker/private/presets/guid      //Use Api Key

Description

This call updates existing preset object.

Precondition

  • Authorization token/Api key is needed.
  • Mandatory elements (should be specified):
    • <preset_guid> - valid preset guid. Take a specific preset guid using Presets List API call.
    • "isActive" - flag to enable or disable preset specified by guid <preset_guid> .If 1 preset is active. If 0 preset is inactive.

Postcondition

  • On success response code should be 200
  • On success message for successful update in JSON format is returned.
  • On failure an error will be returned with the right error code and description.

Example:

[Request] PUT https://<base_api_url>/broker/presets/<preset_guid>
[Request] PUT https://<base_api_url>/broker/private/presets/<preset_guid>
{
  "isActive": 0
}
[Request Headers] {"Content-Type":"application/json","Accept":"application/json","Authorization":"<IdToken>"} //Use token autorization
[Request Headers] {"Content-Type":"application/json","Accept":"application/json","X-Api-Key":"<api_key>"}     //Use Api Key

[Response] 200
[Response Headers] {"Content-Type":["application/json"],"Content-Length":["..."],"Connection":["keep-alive"],"Date":["..... GMT"],"x-amzn-RequestId":["....."],....]}
[Response] 
{
    "status":true,
    "data":"Item was updated successfully"
}

← Stream Variant Manifest →