Skip to content

PUT /jobs/templates/ID

Description

Update a specific Template.

Parameters

  • access_token: string (Required)
    OAuth 2.0 API access token.
  • format: string (Optional)
    Values: json, xml
    This will override Request Accept header.
  • human: boolean (Optional)
    Values: true, false
    Causes the response to be in a structured, more human-readable form. This is useful when calling the API through curl or from a browser.
  • show_null: boolean (Optional)
    Values: true, false
    If set to "true", the response will contain also keys that are not set to a value.
  • expand_all: boolean (Optional)
    Values: true, false
    Recursively look up referenced objects (here: codec id) and embed the respective json as a nested object directly into the response.

Example Request

```bash curl -X PUT -H "application/json" -d '{ \ "template": { \
"name": "My Test Template",
"description": "Adding a new description",
"job_settings": {
"input": {"start_time": 0},
"autograph": { "watermark_strength": "light" },
"user_data" : "My Personal Marker",
"output_prefix": "{job_id}/",
"outputs": [
{
"output_name": "{input_name}",
"thumbnails": [ { "thumbnail_names": "thumb_{resolution}", "thumbnail_preset": "thumbnails_small" } ],
"logos": [
{
"logo_image": "https://s3-us-east-1.amazonaws.com/my_logo_pngs/logo30.png",
"logo_preset": "logo_30_bottom_right"
}
],
"settings": { "video": { "height": "100%", "width": "100%", "bitrate": "90%" } },
"preset": { id: "5e2834a2c35f386a1327c958" }
}
],
"pipeline": { id: "5eb43241e4b0463cfe034c1f" }
}
}
}' "https://api.xvid.com/v1/jobs/templates/?access_token=m9VmyJKTPGFqpkL_THjGE5rkXqfURDYqQ8MTBVidG3PtwkfABIdx6s_z9WlFl4_j&human=true&show_null=true" ```

Valid Fields

Same as for POST /jobs/templates/. Fields not included in the request will not be updated. If you want to delete/reset a field, set it to "null" specifically.