Update existing client policy

This endpoint updates an existing client policy for the environment.

The expected payload is the same as with the endpoint for creating a new client policy, with the difference of having a semantics whereby:

  • any property that is set in the payload will overwrite the data in the existing stored policy
  • omitting the property will keep the existing policy’s property (if any) as-is.

Exception is toMachineIds -property which will always overwrite existing policy’s machine targeting information.

Log in to see full request history
Path Params
string
required

Feedback environment's ID

string
required

Client policy's ID

Body Params

Request payload for creating and updating client policy object.

array of strings

List of client machine IDs this policy will be applied to, or omitted if it applies to all registered clients

toMachineIds
string
required

Name for the policy

boolean
required

Is policy currently enabled

object

Quiet period policy data

object

Automatic popups policy data

object

Popup behaviour policy data

object

Branding policy data

Responses

400

Error in parsing supplied payload for policy update or payload contains invalid data.

404

Requested environment or policy could not be found.

500

Policy update failed, this may be temporary condition. Please employ reasonable exponential backoff algorithm for retrying the call.

503

Temporary error in API, please employ reasonable exponential backoff algorithm for retrying the call.

Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!