Rules

Rule definitions (write — POST)

Create and action rule definitions. Endpoints: POST /api/rule-definitions (create), POST /api/rule-definitions/provision (one-click provision), POST /api/rule-definitions/{id}/clone (clone), POST /api/rule-definitions/{id}/lock (lock for editing), POST /api/rule-definitions/{id}/force-unlock (admin force unlock), POST /api/rule-definitions/{id}/restore (restore from trash), POST /api/rule-definitions/{id}/restore-version (restore historical version), POST /api/rule-definitions/{id}/deploy (deploy rule), POST /api/rule-definitions/{id}/stop (stop rule).

Required scope: rules:write

post/api/rule-definitions

Request

  • Base URL: https://api.chirpwireless.io
  • URL: https://api.chirpwireless.io/api/rule-definitions
  • Auth: API key in header X-API-Key and API key in header X-Organization-Id

Request body

namestring required
descriptionstring
organizationIdstring required
bpmnXmlstring

Base64-encoded BPMN XML diagram

Response

Created

Changes

No recorded changes to this operation across all 1 revision of this API.