esper_cloud_api_Enterprise Policy

Update Enterprise Policy

Enterprise/Compliance Policies are a legacy service and may not be generally available to all customers.

Fully replaces an existing Enterprise Policy (known as a Compliance Policy in the console) for the given policy_id with the values provided in the request body. Use this when you need to overwrite all policy fields at once; for updating only specific fields, use the partial-update (PATCH) variant instead.

Requires a complete EnterprisePolicy object in the request body — any fields omitted are treated as unset — and returns the updated EnterprisePolicy instance.

About Enterprise Policy

An Enterprise Policy defines the configuration and restrictions applied to devices under an enterprise. Policies are referenced by an integer policy_id scoped to the enterprise, and devices report which policy_id/policy_name they're currently associated with.

Key Fields / Query Parameters

  • policy_id — integer identifier for the enterprise policy being updated

Common Use Cases

  • Overwriting an entire policy's configuration in one call after building the full desired state client-side

Best Practices

  • Use PATCH (partial update) instead of PUT when only a subset of policy fields needs to change, to avoid accidentally clearing fields not included in the request body
put/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 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

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.