esper_cloud_api_Enterprise Policy

Partial update EnterprisePolicy

⚠️ Legacy feature. Compliance Policies (along with Templates, which apply them) are a legacy Esper product. For new device configuration work, use Blueprints instead — Compliance Policies remain available for existing Template-based deployments. See Introduction to Compliance Policies: https://help.esper.io/hc/en-us/articles/12653153592977-Introduction-to-Compliance-Policies

Partially updates a Compliance Policy.

Updates one or more fields of the specified Compliance Policy — including its restriction/permission configuration — without requiring the full object in the request body; only included fields are changed. Does not update configurations on devices linked to the policy. Apply a new policy to update the device.

About Compliance Policies A Compliance Policy is a set of device-configuration permissions and restrictions — screen and unlock behavior (keyguard, safe boot), connectivity (USB, tethering, NFC), communication (SMS, outgoing/incoming calls, dialer), hardware (camera, screenshots), and system controls (factory reset, ADB, side-loading, Play Store, app uninstall, date/time configuration) — that gets applied to a device after it has already been provisioned through a Template. They're commonly used to make a post-provisioning change to a Kiosk-mode device, such as temporarily re-enabling the status bar or ADB to pull a bug report, without re-provisioning the device. Templates and Compliance Policies are legacy Esper products; Blueprints are the current, recommended way to define device configuration for new work.

Key Fields / Query Parameters

  • policy_id — UUID of the Compliance Policy to update
  • name — Updated policy name
  • description — Updated description
  • policy — Updated Policy Data object — the restriction/permission toggles
  • is_active — Updated active state

Common Use Cases

  • Temporarily loosening a restriction (e.g., re-enabling ADB or the status bar) on Kiosk devices to pull a bug report
  • Re-tightening restrictions after a troubleshooting session is complete
  • Renaming or deactivating a legacy policy without deleting it outright
patch/enterprise/{enterprise_id}/policy/{policy_id}/

Request

  • Base URL
    https://develop-api.esper.cloud/api
  • URL
    https://develop-api.esper.cloud/api/enterprise/{enterprise_id}/policy/{policy_id}/
  • Auth
    HTTP bearer

Path parameters

policy_idinteger required

An integer identifying this enterprise policy.

enterprise_idstring required

A UUID string identifying enterprise.

Request body */*

uuidstring uuid

Unique Policy identifier

enterprisestring url

Url of the enterprise resource

urlstring url

URL link to policy

namestring

Name of the Policy

descriptionstring

Details regarding the Policy

device_countinteger

Count of Devices with this policy applied

updated_onstring date-time

Last-Updated Timestamp of Policy

created_onstring date-time

Creation Timestamp of Policy

is_activeboolean

Is this policy currently active

google_policy_idstring

Id of the Google policy

Response

successful operation

uuidstring uuid

Unique Policy identifier

enterprisestring url required

Url of the enterprise resource

urlstring url

URL link to policy

namestring required

Name of the Policy

descriptionstring

Details regarding the Policy

device_countinteger

Count of Devices with this policy applied

google_policy_idstring

Id of the Google policy

updated_onstring date-time

Last-Updated Timestamp of Policy

created_onstring date-time

Creation Timestamp of Policy

is_activeboolean

Is this policy currently active

Changes

No recorded changes to this operation across all 6 revisions of this API.