Automation Rules

Changed on

Create an automation rule for the current company. The rule is saved as a draft unless status is set to active. Conditions must include at least one positive condition — a rule made only of negations matches nearly every order line.

post/api/automation-rules/

Request

  • Base URL
    https://api.retraced.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.retraced.com/api/automation-rules/
  • Auth
    none declared

Request body

namestring required
descriptionstring nullable
workflowIdstring
workflowTemplateKeystring
stepConfigsobject
triggerCronstring
timezonestring
status'draft' | 'active'
conditionsSchema0Input (unresolved $ref)

Response

Default Response

Changes

  • e6e038468a94Revision changes
    • info

      added the non-success response with the status

  • b45b2427a621Revision changes
    • breaking

      added to the request property allOf list

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • info

      the request property became optional