Skip to content

Update an existing binder template in your Vault.

By changing the document type/subtype/classification, you can move an existing binder template to a different level of the document type hierarchy, effectively reclassifying the template.

See also: Bulk Update Binder Templates below.

PUT/api/{version}/objects/binders/templates
NameDescription
Content-Typeapplication/x-www-form-urlencoded
Acceptapplication/json (default) or application/xml

You can update the following fields on binder templates:

NameDescription
name__vChange the name of an existing binder template.
label__vChange the label of an existing binder template. This is the name users will see among the available binder templates in the UI.
type__vChange the document type to which the template is associated.
subtype__vChange the document subtype to which the template is associated. This is only required if associating the template with a document subtype.
classification__vChange the document classification to which the template is associated. This is only required if associating the template with a document classification.
active__vSet to true or false to indicate whether or not the binder template should be set to active, i.e., available for selection when creating a binder.

In this example:

  • The input file format is set to application/x-www-form-urlencoded.
  • The response format is set to text/csv.
  • The active__v field is set to false. We're changing the status of this binder template from "Active" to "Inactive".
curl -X PUT -H "Authorization: {SESSION_ID}" \ -H "Content-Type: application/x-www-form-urlencoded" \ -H "Accept: text/csv" \ -d "active__v=true" \ https://myvault.veevavault.com/api/v19.1/objects/binders/templates/binder_template_1__c
responseStatus,name,errors SUCCESS,binder_template_1__c,

On SUCCESS, Vault returns the name of the updated binder template.