Create Binder Template

Create a new binder template in your Vault.

POST/api/{version}/objects/binders/templates

Headers

Name	Description
`Content-Type`	`application/x-www-form-urlencoded`
`Accept`	`application/json` (default) or `application/xml`

Body Parameters

When creating binder templates, the following fields are required in all Vaults:

Name	Description
`name__v` optional	The name of the new binder template. If not included, Vault will use the specified `label__v` value to generate a value for the `name__v` field.
`label__v` required	The label of the new binder template. This is the name users will see among the available binder templates in the UI.
`type__v` required	The name of the document type to which the template will be associated.
`subtype__v` optional	The name of the document subtype to which the template will be associated. This is only required if associating the template with a document subtype.
`classification__v` optional	The name of the document classification to which the template will be associated. This is only required if associating the template with a document classification.
`active__v` required	Set to true or false to indicate whether or not the new binder template should be set to active, i.e., available for selection when creating a binder.

In this example:

The input format is set to application/x-www-form-urlencoded.
The response format is not set and will default to JSON.
The name__v field is not included. Vault will use the specified label__v field value to create the name__v=claim_binder_template__c.
The label__v field specifies the binder template label "Claim Binder Template". This is what users will see among the available templates in the UI.
The document type__v is specified. This template is being created for binders of type__v=claim__c. Since this exists at the document type level, the subtype and classification are not required.
The template is being set to active__v=true. It will be available for selection when creating a new binder.

Request

curl -X POST -H "Authorization: {SESSION_ID}" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "label__v=Claim Binder Template" \
-d "type__v=claim__c" \
-d "active__v=true" \
https://myvault.veevavault.com/api/v25.2/objects/binders/templates

Response

{
   "responseStatus":"SUCCESS",
   "data":[
      {
         "responseStatus":"SUCCESS",
         "name__v":"claim_binder_template__c"
      }
   ]
}

Response Details

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