Skip to main content
A condition changes what a respondent sees while filling a form, for example showing a question only when an earlier answer is “Yes”. An automation rule runs after a submission, for example emailing your sales team. For fields and response details, see the API reference for conditions and automation rules. Both groups of commands take the question ids from neetoform forms questions list <form-id>.

List conditions

This command lists the conditional logic of a form in the order it is checked.
Required arguments:
  • <form-id> - The form’s UUID, from neetoform forms list
Sample output (--json)

Show a condition

This command shows one condition of a form.
Required arguments:
  • <form-id> - The form’s UUID, from neetoform forms list
  • <condition-id> - The condition’s UUID, from neetoform forms conditions list

Create a condition

This command creates a condition. It is added after the last one.
Required arguments:
  • <form-id> - The form’s UUID, from neetoform forms list
--json-file holds the condition: a conditions object with the tests, and an actions object with what happens when they match. join_type is and (all items must match) or or (any item). In an item, record is custom_value to compare with value, or the id of another question to compare with its answer. For choice questions, value is the id of the option. This file shows the question 9a3f... only when question 5b0d... is answered “Yes”:
Every key is optional. --enabled turns the condition on or off and overrides enabled in the file; it defaults to on. The values of verb and action_type are stored as you send them, so check the spelling against the API reference.

Update a condition

This command changes a condition. Send only the keys you want to change.
Required arguments:
  • <form-id> - The form’s UUID, from neetoform forms list
  • <condition-id> - The condition’s UUID, from neetoform forms conditions list
When the file has conditions or actions, it replaces the whole current value, so include every item you want to keep.

Delete a condition

This command deletes a condition.
Required arguments:
  • <form-id> - The form’s UUID, from neetoform forms list
  • <condition-id> - The condition’s UUID, from neetoform forms conditions list

Clone a condition

This command copies a condition. Use this when a new condition is close to an existing one.
Required arguments:
  • <form-id> - The form’s UUID, from neetoform forms list
  • <condition-id> - The condition’s UUID, from neetoform forms conditions list

Reorder conditions

This command sets the order in which conditions are checked.
Required arguments:
  • <form-id> - The form’s UUID, from neetoform forms list
--ids must list every condition id of the form.

List automation rules

This command lists the automation rules of a form. Use --search to match words in a rule’s name, description or condition field.
Required arguments:
  • <form-id> - The form’s UUID, from neetoform forms list
Sample output (--json)
The list shows a summary of each rule. Run show to see its events, conditions and actions.

Show an automation rule

This command shows one rule with its events, conditions and actions.
Required arguments:
  • <form-id> - The form’s UUID, from neetoform forms list
  • <rule-id> - The rule’s UUID, from neetoform forms automation-rules list

Create an automation rule

This command creates a rule. A rule runs its actions, such as sending an email or calling an API endpoint, when its events happen and its conditions match.
Required arguments:
  • <form-id> - The form’s UUID, from neetoform forms list
--name is required and must be unique in the form, ignoring case. --status accepts enabled or disabled, --events accepts submission_created and custom_field_updated, and --delay-unit accepts minutes, hours or days. Wrong values are rejected before a request is made. --json-file holds the conditions and actions of the rule, and may also hold the other fields. A flag overrides the same key in the file. This file sends the answers to the sales team when the email address of question 5b0d... contains @example.com:
Actions such as email_to and sms_to contact real people as soon as the rule is enabled and a submission arrives. Create the rule with --status disabled while you test it.

Update an automation rule

This command changes a rule. Only the fields you pass change.
Required arguments:
  • <form-id> - The form’s UUID, from neetoform forms list
  • <rule-id> - The rule’s UUID, from neetoform forms automation-rules list

Delete an automation rule

This command deletes a rule.
Required arguments:
  • <form-id> - The form’s UUID, from neetoform forms list
  • <rule-id> - The rule’s UUID, from neetoform forms automation-rules list

Clone an automation rule

This command copies a rule. Use this when a new rule is close to an existing one.
Required arguments:
  • <form-id> - The form’s UUID, from neetoform forms list
  • <rule-id> - The rule’s UUID, from neetoform forms automation-rules list

Reorder automation rules

This command sets the order in which rules run.
Required arguments:
  • <form-id> - The form’s UUID, from neetoform forms list
--ids must list every rule id of the form.