Promote a specific version of a file.

If previous versions exist, this method can be used to promote one of the older versions to the top of the version history.

This creates a new copy of the old version and puts it at the top of the versions history. The file will have the exact same contents as the older version, with the the same hash digest, etag, and name as the original.

Other properties such as comments do not get updated to their former values.

Don’t use this endpoint to restore Box Notes, as it works with file formats such as PDF, DOC, PPTX or similar.

​
Parameters

ParameterDescription
File IDThe unique identifier that represents a file.
File Version IDThe file version ID.

​
Example Output

{
	"created_at": "2012-12-12T10:53:43-08:00",
	"id": "12345",
	"modified_at": "2012-12-12T10:53:43-08:00",
	"modified_by": {
		"id": "11446498",
		"login": "ceo@example.com",
		"name": "Aaron Levie",
		"type": "user"
	},
	"name": "tigers.jpeg",
	"purged_at": "2012-12-12T10:53:43-08:00",
	"restored_at": "2012-12-12T10:53:43-08:00",
	"restored_by": {
		"id": "11446498",
		"login": "ceo@example.com",
		"name": "Aaron Levie",
		"type": "user"
	},
	"sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc",
	"size": 629644,
	"trashed_at": "2012-12-12T10:53:43-08:00",
	"trashed_by": {
		"id": "11446498",
		"login": "ceo@example.com",
		"name": "Aaron Levie",
		"type": "user"
	},
	"type": "file_version",
	"uploader_display_name": "Ellis Wiggins"
}

​
Workflow Library Example

Promote File Version with Box and Send Results Via Email

Preview this Workflow on desktop

Was this page helpful?