# Update Label

PATCH /{labelId}

#### Description

Updates an existing label identified by its ID, allowing changes to its name, description, or associated metadata.

Endpoint: PATCH /{labelId}
Version: 1.0
Security: oauth2

## Path parameters:

  - `labelId` (string, required)
    Unique ID of the label to update.

## Request fields (application/json):

  - `name` (string)
    The name of the label.
    Example: "Acceptable use of assets"

  - `description` (string)
    The description of the label.
    Example: "List of acceptable uses of assets by company employees."

  - `freshnessPolicy` (string)
    The freshness policy of an object. Set to 'manual' with a 'freshAsOfDate' value otherwise 'freshness' will be set to 'unknown'.
    Enum: "none", "manual"

  - `freshForDuration` (string)
    Sets the duration after which the label becomes stale. Supply as a string in standard ISO-8601 duration format ex: P1Y3M2D or PT720H
    Example: "PT720H"

  - `freshness` (string)
    The freshness status of an object. Cannot be set if 'freshnessPolicy' is 'none' and 'freshAsOfDate' is null.
    Enum: "noFreshness", "fresh", "expired", "unknown"

  - `freshAsOfDate` (string)
    Sets the date and time when the label was last fresh.
    Example: "2025-01-12T18:26:10.00.5365Z"

  - `freshAsOfNote` (string)
    Adds a note when setting freshness. Cannot be set without also updating freshAsOfDate
    Example: "Updating expired label freshness"

  - `resetFreshnessNote` (string)
    Adds a note for resetting a label's freshness with an existing freshness policy.

  - `customFields` (array)
    Example: [{"fieldId":"ceb912ab-519b-11ee-a644-522476618ae8","value":"Antonio Moreno"}]

  - `customFields.fieldId` (string)
    Unique identifier for the custom field

  - `customFields.textValue` (string)
    Value if the field type is text

  - `customFields.numberValue` (number)
    Value if the field type is number

  - `customFields.dateValue` (string)
    Value if the field type is date

  - `customFields.userValue` (string)
    Value if the field type is user

  - `customFields.selections` (array)
    List of values for textMultiSelect

  - `status` (string)
    The status of the object
    Enum: "active", "archived"

## Response 200 fields (application/json):

  - `id` (string)
    The unique identifier of the label.
    Example: "d88d505d-5199-11ee-a644-522476618ae8"

  - `orgId` (string)
    The unique identifier for the organization the label belongs to.
    Example: "ce83e3cd-5199-11ee-a644-522476618ae8"

  - `name` (string)
    The name of the label.
    Example: "Acceptable use of assets"

  - `description` (string)
    The description of the label.
    Example: "List of acceptable uses of assets by company employees."

  - `freshnessPolicy` (string)
    The freshness policy of an object. Set to 'manual' with a 'freshAsOfDate' value otherwise 'freshness' will be set to 'unknown'.
    Enum: "none", "manual"

  - `freshForDuration` (string)
    The duration after which label becomes stale.
    Example: "PT720H"

  - `freshness` (string)
    The freshness status of an object. Cannot be set if 'freshnessPolicy' is 'none' and 'freshAsOfDate' is null.
    Enum: "noFreshness", "fresh", "expired", "unknown"

  - `freshAsOfDate` (string)
    The date when the label was last marked 'fresh' (ISO-8601 format).
    Example: "2025-01-12T18:26:10.00.5365Z"

  - `freshAsOfNote` (string)
    The note populated when the label was marked 'fresh'.
    Example: "Initial freshness set"

  - `createdBy` (string)
    The unique identifier of the user who created the label.
    Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"

  - `createdOn` (string)
    The date and time the label was created (ISO-8601 format).
    Example: "2025-01-12T18:26:10.005365Z"

  - `updatedBy` (string)
    The unique identifier of the user who last updated the label.
    Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"

  - `updatedOn` (string)
    The date and time the label was last updated (ISO-8601 format).
    Example: "2025-01-12T18:26:10.005365Z"

  - `customFields` (array)
    The custom fields for the label.

  - `customFields.fieldId` (string)
    Unique identifier for the custom field

  - `customFields.fieldName` (string)
    Name of the custom field

  - `customFields.fieldType` (string)
    Type of field
    Enum: "text", "number", "date", "user", "textSingleSelect", "textMultiSelect"

  - `customFields.numberFormat` (string)
    Format if the field type is number
    Enum: "decimal", "percentage"

  - `customFields.textValue` (string)
    Value if the field type is text

  - `customFields.numberValue` (number)
    Value if the field type is number

  - `customFields.dateValue` (string)
    Value if the field type is date

  - `customFields.userValue` (string)
    Value if the field type is user

  - `customFields.selection` (string)
    Value for textSingleSelect

  - `customFields.selections` (array)
    List of values for textMultiSelect

  - `status` (string)
    The status of the object
    Enum: "active", "archived"

  - `permissions` (array)
    The list of permissions for the label.
    Example: []

  - `_isPartialData` (boolean)
    This is true when the user does not have read permissions on the label.