api.clarify.io
  1. bundles
api.clarify.io
  • bundles
    • List bundles
      GET
    • Create a bundle
      POST
    • Delete a bundle
      DELETE
    • Get a bundle
      GET
    • Update a bundle
      PUT
    • Get bundle insights
      GET
    • Request an insight to be run
      POST
    • Get bundle insight
      GET
    • Delete bundle metadata
      DELETE
    • Get bundle metadata
      GET
    • Update bundle metadata
      PUT
    • Delete bundle tracks
      DELETE
    • Get bundle tracks
      GET
    • Add a track for a bundle
      POST
    • Update a tracks for a bundle
      PUT
    • Delete a bundle track
      DELETE
    • Get bundle track
      GET
    • Add media to a track
      PUT
  • reports
    • Generate Group Report <span class="label">beta</span>
      GET
    • Generate Trends Report <span class="label">beta</span>
      GET
  • search
    • Search bundles
      GET
  1. bundles

Update a bundle

PUT
/v1/bundles/{bundle_id}
Update a bundle. To update the tracks, media, or metadata of a bundle, use the tracks and metadata endpoints.

name can be any string you wish to associate with the bundle.

external_id is an optional parameter that can be used to logically link a bundle to an item in an external system. The external_id can be whatever you use to identify items in your own database.

notify_url is a webhook. It must be a publicly accessible url (http or https) on your server to which notifications for the bundle will be POSTed. There are three types of notifications: Track Notifications, Insight Notifications and Bundle Notifications. For more information on the content of notifications and when they are sent, see the notification docs page.

If version is specified, the bundle will only be updated if the current version matches this parameter value. If the version doesn't match, a 409 Conflict error will be returned. If version not specified, the bundle will always be updated.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://api.clarify.io//v1/bundles/'
Response Response Example
200 - Example 1
{}

Request

Path Params
bundle_id
string 
required
id of a bundle
Body Params application/x-www-form-urlencoded
name
string 
optional
Name of the bundle. Up to 128 characters.
notify_url
string 
optional
URL for notifications on this bundle. Up to 2083 characters.
external_id
string 
optional
A string that can refer to an item in an external system. Up to 128 characters.
version
string 
optional
Object version.

Responses

🟢200No response was specified
application/json
Body
object {0}
🟢202Accepted
🟠400Bad request
🟠404Not found
🟠409Conflict
Modified at 2022-09-10 16:56:00
Previous
Get a bundle
Next
Get bundle insights
Built with