Initiating a policy change

Policy changes are initiated from the policy itself. Use the following endpoint to create a policy change for a given policy:

  • POST /policy/v1/policies/{policyId}/change

You must specify a jobEffectiveDate for the policy change.

For example, the following initiates a policy change for policy pc:44 with an effective date of June 6, 2023.

POST /policy/v1/policies/pc:44/change

{
  "data": {
    "attributes": {
      "jobEffectiveDate": "2023-06-06"
    }
  }
}

This call creates a new job instance whose job type is "PolicyChange".