Update Label

Updates an existing label with new values. User must have the label.update scope.

External Documentation

To learn more, visit the Hyperproof documentation.

​

Basic Parameters

Parameter	Description
Cancellations	Json object of an array of cancellations. Example: [ { “historyId”:“historyId”, “note”:“note” } ] For further explanation on how to use this parameter refer to Hyperproof’s documentation.
Description	The description of the label.
Label ID	The unique identifier of the label to update. Can be obtained by using the List Labels action.
Name	The name of the label.

​

Advanced Parameters

Parameter	Description
Fresh As Of Date	The fresh as of date of the label.
Fresh As Of Note	The fresh as of note of the label.
Fresh For Duration	The fresh for duration of the label.
Freshness Policy	The freshness policy of the label.
Reset Freshness Note	The reset freshness note.

​

Example Output

{
	"id": "string",
	"orgId": "string",
	"name": "string",
	"description": "string",
	"freshnessPolicy": "string",
	"freshForDuration": "string",
	"createdBy": {
		"id": "string",
		"email": "string",
		"givenName": "string",
		"surname": "string",
		"profilePhotoName": "string",
		"userId": "string",
		"roleIds": [
			"string"
		],
		"state": "string"
	},
	"createdOn": "string",
	"updatedBy": {
		"id": "string",
		"email": "string",
		"givenName": "string",
		"surname": "string",
		"profilePhotoName": "string",
		"userId": "string",
		"roleIds": [
			"string"
		],
		"state": "string"
	},
	"updatedOn": "string",
	"status": "string",
	"permissions": [
		"string"
	]
}