Update Form By Id

curl --request PUT \
  --url 'https://api.example.com/api/v1/form/{form_id}?api_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "trigger_instructions": "<string>",
  "attributes": {},
  "fields": [
    "<unknown>"
  ],
  "webhook_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "trigger_tools": [
    "<unknown>"
  ],
  "contact_mapping": {}
}
'

import requests

url = "https://api.example.com/api/v1/form/{form_id}?api_key="

payload = {
    "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "trigger_instructions": "<string>",
    "attributes": {},
    "fields": ["<unknown>"],
    "webhook_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "trigger_tools": ["<unknown>"],
    "contact_mapping": {}
}
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    org_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    name: '<string>',
    trigger_instructions: '<string>',
    attributes: {},
    fields: ['<unknown>'],
    webhook_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    trigger_tools: ['<unknown>'],
    contact_mapping: {}
  })
};

fetch('https://api.example.com/api/v1/form/{form_id}?api_key=', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/form/{form_id}?api_key=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'org_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'name' => '<string>',
    'trigger_instructions' => '<string>',
    'attributes' => [
        
    ],
    'fields' => [
        '<unknown>'
    ],
    'webhook_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'trigger_tools' => [
        '<unknown>'
    ],
    'contact_mapping' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/form/{form_id}?api_key="

	payload := strings.NewReader("{\n  \"org_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"trigger_instructions\": \"<string>\",\n  \"attributes\": {},\n  \"fields\": [\n    \"<unknown>\"\n  ],\n  \"webhook_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"trigger_tools\": [\n    \"<unknown>\"\n  ],\n  \"contact_mapping\": {}\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.example.com/api/v1/form/{form_id}?api_key=")
  .header("Content-Type", "application/json")
  .body("{\n  \"org_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"trigger_instructions\": \"<string>\",\n  \"attributes\": {},\n  \"fields\": [\n    \"<unknown>\"\n  ],\n  \"webhook_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"trigger_tools\": [\n    \"<unknown>\"\n  ],\n  \"contact_mapping\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/form/{form_id}?api_key=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"org_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"trigger_instructions\": \"<string>\",\n  \"attributes\": {},\n  \"fields\": [\n    \"<unknown>\"\n  ],\n  \"webhook_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"trigger_tools\": [\n    \"<unknown>\"\n  ],\n  \"contact_mapping\": {}\n}"

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

{
  "message": "Data updated successfully",
  "meta": {},
  "data": {
    "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "trigger_instructions": "<string>",
    "form_type": "natural",
    "attributes": {},
    "fields": [
      "<unknown>"
    ],
    "webhook_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "trigger_tools": [
      "<unknown>"
    ],
    "contact_mapping": {}
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

PUT

api

form

{form_id}

Update Form By Id

curl --request PUT \
  --url 'https://api.example.com/api/v1/form/{form_id}?api_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "trigger_instructions": "<string>",
  "attributes": {},
  "fields": [
    "<unknown>"
  ],
  "webhook_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "trigger_tools": [
    "<unknown>"
  ],
  "contact_mapping": {}
}
'

import requests

url = "https://api.example.com/api/v1/form/{form_id}?api_key="

payload = {
    "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "trigger_instructions": "<string>",
    "attributes": {},
    "fields": ["<unknown>"],
    "webhook_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "trigger_tools": ["<unknown>"],
    "contact_mapping": {}
}
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    org_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    name: '<string>',
    trigger_instructions: '<string>',
    attributes: {},
    fields: ['<unknown>'],
    webhook_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    trigger_tools: ['<unknown>'],
    contact_mapping: {}
  })
};

fetch('https://api.example.com/api/v1/form/{form_id}?api_key=', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/form/{form_id}?api_key=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'org_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'name' => '<string>',
    'trigger_instructions' => '<string>',
    'attributes' => [
        
    ],
    'fields' => [
        '<unknown>'
    ],
    'webhook_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'trigger_tools' => [
        '<unknown>'
    ],
    'contact_mapping' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/form/{form_id}?api_key="

	payload := strings.NewReader("{\n  \"org_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"trigger_instructions\": \"<string>\",\n  \"attributes\": {},\n  \"fields\": [\n    \"<unknown>\"\n  ],\n  \"webhook_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"trigger_tools\": [\n    \"<unknown>\"\n  ],\n  \"contact_mapping\": {}\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.example.com/api/v1/form/{form_id}?api_key=")
  .header("Content-Type", "application/json")
  .body("{\n  \"org_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"trigger_instructions\": \"<string>\",\n  \"attributes\": {},\n  \"fields\": [\n    \"<unknown>\"\n  ],\n  \"webhook_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"trigger_tools\": [\n    \"<unknown>\"\n  ],\n  \"contact_mapping\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/form/{form_id}?api_key=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"org_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"trigger_instructions\": \"<string>\",\n  \"attributes\": {},\n  \"fields\": [\n    \"<unknown>\"\n  ],\n  \"webhook_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"trigger_tools\": [\n    \"<unknown>\"\n  ],\n  \"contact_mapping\": {}\n}"

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

{
  "message": "Data updated successfully",
  "meta": {},
  "data": {
    "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "trigger_instructions": "<string>",
    "form_type": "natural",
    "attributes": {},
    "fields": [
      "<unknown>"
    ],
    "webhook_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "trigger_tools": [
      "<unknown>"
    ],
    "contact_mapping": {}
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

api_key

string

query

required

Your API key for authentication. You can generate it from the Settings page. Format: starts with in-.

Path Parameters

form_id

string<uuid>

required

Body

application/json

org_id

string<uuid> | null

name

string | null

trigger_instructions

string | null

form_type

enum<string> | null

Available options:

natural,

simple

attributes

Attributes · object | null

fields

any[] | null

webhook_id

string<uuid> | null

trigger_tools

any[] | null

contact_mapping

Contact Mapping · object | null

Response

Successful Response

message

string | null

default:Data updated successfully