FormFieldCondition

A rule that conditionally shows a form field based on the answer given to another (trigger) field.

A condition belongs to the form_field it shows, and points at a trigger_form_field whose answer determines whether that field is displayed. A form field can have at most one condition. The trigger is matched in one of two ways:

• trigger_form_field_option — the condition is met when the answer to the trigger field is this option (used for option-based fields such as dropdowns, gender, campus, etc.).
• trigger_form_field_option_value — the condition is met when the answer to the trigger field equals this string (used for boolean custom fields).

When neither is set, the condition is met whenever the trigger field has any answer.

Conditions are created, updated, and destroyed under the form field they belong to (POST/PATCH/DELETE .../fields/{id}/form_field_conditions). The form_field and trigger_form_field must both belong to the same form, and the trigger_form_field_option must belong to the trigger_form_field. Writing requires permission to manage the form.

curl https://api.planningcenteronline.com/people/v2/forms/{form_id}/fields/{field_id}/form_field_conditions

{
  "type": "FormFieldCondition",
  "id": "1",
  "attributes": {
    "created_at": "2000-01-01T12:00:00Z",
    "trigger_form_field_option_value": "string",
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {
    "form_field": {
      "data": {
        "type": "FormField",
        "id": "1"
      }
    },
    "trigger_form_field": {
      "data": {
        "type": "FormField",
        "id": "1"
      }
    },
    "trigger_form_field_option": {
      "data": {
        "type": "FormFieldOption",
        "id": "1"
      }
    }
  }
}