Skip to main content
Updates an existing label with new values. User must have the label.update scope.
External DocumentationTo learn more, visit the Hyperproof documentation.

​
Basic Parameters

ParameterDescription
CancellationsJson 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.
DescriptionThe description of the label.
Label IDThe unique identifier of the label to update. Can be obtained by using the List Labels action.
NameThe name of the label.

​
Advanced Parameters

ParameterDescription
Fresh As Of DateThe fresh as of date of the label.
Fresh As Of NoteThe fresh as of note of the label.
Fresh For DurationThe fresh for duration of the label.
Freshness PolicyThe freshness policy of the label.
Reset Freshness NoteThe 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"
	]
}

​
Workflow Library Example

Update Label with Hyperproof and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop