Reclassify Single Document

Reclassify allows you to change the document type of an existing document or assign a document type to an unclassified document. This endpoint is analogous to the Reclassify action in the Vault UI.

A document "type" is the combination of the type__v, subtype__v, and classification__v fields on a document. When you reclassify, Vault may add or remove certain fields on the document. Add these new fields and values to the body of this request. If a new required field is missing, the error response will list the name of the required field. To reclassify more than one document, use the Reclassify Multiple Documents endpoint.

Not all documents are eligible for reclassification. For example, you can only reclassify the latest version of a document and you cannot reclassify a checked out document. Learn more about reclassifying documents in Vault Help.

PUT/api/{version}/objects/documents/{doc_id}

Headers

Name	Description
`Content-Type`	`application/x-www-form-urlencoded`
`Accept`	`application/json` (default) or `application/xml`
`X-VaultAPI-MigrationMode`	When set to `true`, Vault allows you to manually set the document number and to update documents to any lifecycle state using the `status__v` field. Vault does not send notifications in Document Migration Mode. All other Document Migration Mode overrides available at document creation are ignored, but do not generate an error message. You must have the Document Migration permission to use this header. Learn more about Document Migration Mode in Vault Help.
`X-VaultAPI-NoTriggers`	If set to `true` and Document Migration Mode is enabled, it bypasses all system, standard, and custom doctype triggers.

URI Path Parameters

Name	Description
`{doc_id}`	The document `id` field value.

Body Parameters

You can also add or remove values for any other editable document field. Note that additional fields may be required depending on the document type, subtype, and classification being assigned to the document. Use the Document Metadata API to retrieve required and editable fields in your Vault. If a required field is missing, the error response will list the name of the required field.

Name	Description
`type__v` required	The name of the document type.
`subtype__v` optional	The name of the document subtype (if one exists on the type).
`classification__v` optional	The name of the document classification (if one exists on the subtype).
`lifecycle__v` required	The name of the document lifecycle.
`reclassify` required	Set to `true`. Without this, a standard document update action is performed.
`document_number__v` optional	The document number for the reclassified document. If omitted, the document retains the existing document number. You must set both the `reclassify` parameter and the `X-VaultAPI_MigrationMode` header to `true` to change the document number, and you can only include this parameter when you also change the document lifecycle or type, subtype, or classification.
`status__v` optional	Specifies the document lifecycle state for the reclassified document. If omitted, the document retains the existing state. You must set both the `reclassify` parameter and the `X-VaultAPI_MigrationMode` header to `true` to change the state, and you can only include this parameter when you also change the document lifecycle or type, subtype, or classification.

Request

curl -X PUT -H "Authorization: {SESSION_ID}" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "reclassify=true" \
-d "type__v=Promotional Piece" \
-d "subtype__v=Advertisement" \
-d "classification__v=Web" \
-d "lifecycle__v=Promotional Piece" \
https://myvault.veevavault.com/api/v26.1/objects/documents/775

Response

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