Other/api.clarify.io

Update bundle metadata

v1.0.0

Update the metadata for a bundle.

The metadata is a single-level JSON object of your own definition, containing key-values that can be searched and filtered on. Metadata can be used to hold text such as names, titles, descriptions and values for segregating bundles, for example by user, topic, folder name etc. The keys (property names) can be up to 64 characters and must contain only alphanumeric characters and underscore (but not start with underscore) and must not be a reserved name. Reserved names are "true", "false", and "null". Values can be strings, numbers, boolean true/false, date-times represented as a string in ISO 8601 format (ex. "2014-02-25T14:23:45.000Z"), or an array of these primitive types. Strings can be up to 2000 characters and strings in arrays can be up to 128 characters each. Nested objects are not allowed. Metadata can contain up to 50 key-value pairs up to a total JSON size of 4000 characters.

To clear the metadata for a bundle, send data={}.

If version specified, the metadata will only be updated if the current version matches this parameter value. If the version doesn't match, a 409 Conflict will be returned. If version not specified, the metadata will always be updated.

Input

{
  "type": "object",
  "properties": {
    "bundle_id": {
      "type": "string"
    }
  },
  "required": [
    "bundle_id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "additionalProperties": true
}