Skip to content

Policies

Policies: schedules that automatically create reviews, actions or flows on a regular basis.

Base path
/policy

Endpoints

16 endpoints

Method

Standard Operations

7
  • GET /policy List policies (with search, filters and paging).
  • POST /policy Create a new policy.
  • PATCH /policy/bulk Update several policies at once.
  • GET /policy/{id} Open a single policy.
  • PUT /policy/{id} Replace a policy's details in full.
  • PATCH /policy/{id} Edit a policy.
  • DELETE /policy/{id} Delete a policy.

Additional Operations

9
  • GET /policy/{policyId}/files List documents attached to a policy.
  • POST /policy/{policyId}/files Attach a document to a policy.
  • PATCH /policy/{policyId}/file/{fileId} Update a document attached to a policy.
  • DELETE /policy/{policyId}/file/{fileId} Remove a document from a policy.
  • GET /policy/{policyId}/frequencies Show how often a policy runs.
  • PUT /policy/{policyId}/frequencies Set how often a policy runs.
  • PUT /policy/{policyId}/groups Set which user groups a policy assigns work to.
  • POST /policy/preview-entities Preview which records a policy would apply to.
  • GET /policy/get-by-entity List policies that apply to a record.