Reclassify Binder

Reclassify allows you to change the document type of an existing binder. A document "type" is the combination of the type__v, subtype__v, and classification__v fields on a binder. When you reclassify, Vault may add or remove certain fields on the binder. You can only reclassify the latest version of a binder and only one binder at a time. The API does not currently support Bulk Reclassify.

Learn more about:

Vault Help: Reclassifying Documents.
API: Retrieve Binders
API: Retrieve Document Fields
API: Retrieve Document Types, Subtypes, and Classifications

About this Request

You can only reclassify the latest version of a specified binder.
You can only reclassify one binder at a time. Bulk reclassify is not currently supported.

PUT/api/{version}/objects/binders/{binder_id}

Headers

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

URI Path Parameters

Name	Description
`{binder_id}`	The binder `id` field value.

Body Parameters

Name	Description
`reclassify`	Set to `true`. Without this, a standard binder update action is performed.
`type__v`	The name of the document type being assigned to the binder.
`subtype__v`	The name of the document subtype (if one exists on the type).
`classification__v`	The name of the document classification (if one exists on the subtype).
`lifecycle__v`	The name of the lifecycle.

You can also add or remove values for any other editable field.

Note that additional fields may be required depending on the document type, subtype, and classification being assigned to the binder.

Use the Document Metadata API to retrieve required and editable fields in your Vault.

Request

curl -X PUT -H "Authorization: {SESSION_ID}" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "reclassify=true" \
-d "type__v=Claim" \
-d "lifecycle__v=Binder Lifecycle" \
https://myvault.veevavault.com/api/v17.2/objects/binders/776

Response

{
    "responseStatus": "SUCCESS",
    "id": 776
}