Edit a form

Needs: Forms, Read-write

Edits a form with ordered operations. They are all saved together or not at all, and the form builder's rules are checked. The edit is refused if it would break a rule or a mapping. A published form changes immediately for submitters.

Operations

set_details: name, description, tags (names, or {name, color} only if a colour is wanted).
add_step, update_step, remove_step, move_step, duplicate_step: steps, by step_id, position or after_step_id.
add_field, update_field, remove_field, move_field, duplicate_field: fields, by field_id, step_id, position or after_field_id.
set_visibility: field_id and visible_if (effect, combinator, conditions), or null to remove.
set_routing: step_id and rules (name, go_to a step id or submit, combinator, conditions, enabled), or null.
update_settings: step numbers, step navigation, button text, success message, submitter id collection, redirect URL, response assignment, embed options, locking, cover style and icon, and branding.
set_incident, set_prospect, set_client_prefill: map form fields to incident or prospect fields, or pre-fill client fields. Custom attribute keys come from the field types endpoint.

Removing a field or step also removes the rules and mappings that used it. Locked fields must be unlocked first.

curl -X PATCH "https://app.imploy.com.au/api/integrations/v1/forms/123" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "operations": [
    {
      "op": "add_field",
      "step_id": "step_1",
      "field": {
        "type": "textarea",
        "label": "Anything else?"
      }
    },
    {
      "op": "update_settings",
      "submit_button_text": "Send feedback"
    }
  ]
}'

import requests
import json

url = "https://app.imploy.com.au/api/integrations/v1/forms/123"
headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
}
data = {
  "operations": [
    {
      "op": "add_field",
      "step_id": "step_1",
      "field": {
        "type": "textarea",
        "label": "Anything else?"
      }
    },
    {
      "op": "update_settings",
      "submit_button_text": "Send feedback"
    }
  ]
}

response = requests.patch(url, headers=headers, json=data)
print(response.json())

const response = await fetch("https://app.imploy.com.au/api/integrations/v1/forms/123", {
  method: "PATCH",
  headers: {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
},
  body: JSON.stringify({
  "operations": [
    {
      "op": "add_field",
      "step_id": "step_1",
      "field": {
        "type": "textarea",
        "label": "Anything else?"
      }
    },
    {
      "op": "update_settings",
      "submit_button_text": "Send feedback"
    }
  ]
})
});

const data = await response.json();
console.log(data);

package main

import (
    "fmt"
    "net/http"
    "bytes"
    "encoding/json"
)

func main() {
    data := []byte(`{
  "operations": [
    {
      "op": "add_field",
      "step_id": "step_1",
      "field": {
        "type": "textarea",
        "label": "Anything else?"
      }
    },
    {
      "op": "update_settings",
      "submit_button_text": "Send feedback"
    }
  ]
}`)

    req, err := http.NewRequest("PATCH", "https://app.imploy.com.au/api/integrations/v1/forms/123", bytes.NewBuffer(data))
    if err != nil {
        panic(err)
    }

    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    fmt.Println("Response Status:", resp.Status)
}

require 'net/http'
require 'json'

uri = URI('https://app.imploy.com.au/api/integrations/v1/forms/123')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
request.body = '{
  "operations": [
    {
      "op": "add_field",
      "step_id": "step_1",
      "field": {
        "type": "textarea",
        "label": "Anything else?"
      }
    },
    {
      "op": "update_settings",
      "submit_button_text": "Send feedback"
    }
  ]
}'

response = http.request(request)
puts response.body

{
  "updated": 14,
  "id": 14,
  "name": "Visit feedback",
  "description": "Collect feedback after a visit.",
  "published": "off",
  "url": null,
  "settings": {
    "allow_step_navigation": false,
    "show_step_numbers": true,
    "submit_button_text": "Submit"
  }
}