Migrate to Management API v2

• An account may contain multiple sites.
• An account is the same as a JWP dashboard

• The query parameter type in v1 is now the path parameter playlist_type.
• Custom parameters (accessed as custom.{param}) are now a single field called custom_params.
• With the exception of author, description, link, and title, all other fields have been moved to the subresource for each playlist type (article matching, dynamic, manual, recommendations, search, and trending).

• The template field has been removed.

• The duration field has been removed from media_renditions and is only available on originals.
• The template field has been removed.
• The link field has been replaced with a single string field delivery_url.
• The filesize field is now an integer instead of a string.

• Custom parameters (accessed as custom.{param}) are now a single field called custom_params.
• With the exception of release_channel and name, all other fields have been moved to the setup_config object.

• A thumbnail can be explicitly chosen to be the poster for a media.
• A list of previous thumbnails can be retrieved.

• The link object is now a single string field called delivery_url.
• The md5 and size fields have been removed.

• The date field has been renamed publish_start_date.
• The error field has been renamed error_message.
• The expires_date field has been renamed publish_end_date.
• The link field has been renamed permalink.
• The mediatype field has been renamed media_type.
• The sourceformat field has been renamed mime_type.
• The sourcetype field has been renamed hosting_type.

• Custom parameters (accessed as custom.{param}) are now a single field called custom_params.
• The md5 and size fields have been removed.
• The upload configuration fields (method, mime_type, source_url, download_url, trim_in_point, trim_out_point) are now in a separate upload object. Learn about uploading content in API v2.

{
  "custom.example1": "value",
  "custom.-example2": null
}

If a parameter already exists in the database, it will be updated with the new value.

If a parameter name starts with -, parameter with the same name (but without leading -) will be deleted from the database.

{
  "metadata": {
    "custom_params": {
      "example1": "value"
    }
  }
}

When updating existing custom_params, include all custom_params keys with their updated values.

Any custom_params key-value pair not included within the updated custom_params in the request body is deleted.

{
    "metadata": {
        "name": "Example player",
        "release_channel": "latest",
        "setup_config": {
            "aspectratio": "16:9",
            "responsive": true,
            "autostart": false,
            "displaydescription": true,
            "displaytitle": true,
            "playbackRateControls": true,
            "preload": "metadata",
            "repeat": false,
            "stretching": "uniform"
        }
    }
}

With the exception of release_channel and name, all other fields have been moved to the setup_config object. This change enables support for any options available in the player but removes API validation.

{
  "code": "ServerError",
  "message": "Something went wrong!"
}

This format only contains a single error at a time. If there were multiple errors with your request it could be a tedious process to address them one at a time.

{
    "errors": [{
        "code": "server_error",
        "description": "Something went wrong!"
    }]
}

Multiple errors may be returned in a single response. This allows you to see and respond to multiple errors with your request at once.

The code field still refers to a short string intended for automation while description (formerly message) is a human-readable explanation.