Update a form

curl --request PUT \
  --url https://api.paubox.com/v1/forms/api/forms/{form_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "Patient Intake Form (2024)",
  "active": true
}
'

import requests

url = "https://api.paubox.com/v1/forms/api/forms/{form_id}"

payload = {
    "title": "Patient Intake Form (2024)",
    "active": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({title: 'Patient Intake Form (2024)', active: true})
};

fetch('https://api.paubox.com/v1/forms/api/forms/{form_id}', 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.paubox.com/v1/forms/api/forms/{form_id}",
  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([
    'title' => 'Patient Intake Form (2024)',
    'active' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.paubox.com/v1/forms/api/forms/{form_id}"

	payload := strings.NewReader("{\n  \"title\": \"Patient Intake Form (2024)\",\n  \"active\": true\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.paubox.com/v1/forms/api/forms/{form_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"Patient Intake Form (2024)\",\n  \"active\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paubox.com/v1/forms/api/forms/{form_id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"Patient Intake Form (2024)\",\n  \"active\": true\n}"

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

{
  "detail": "Form updated successfully",
  "form_id": "550e8400-e29b-41d4-a716-446655440000"
}

PUT

api

forms

{form_id}

Update a form

curl --request PUT \
  --url https://api.paubox.com/v1/forms/api/forms/{form_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "Patient Intake Form (2024)",
  "active": true
}
'

import requests

url = "https://api.paubox.com/v1/forms/api/forms/{form_id}"

payload = {
    "title": "Patient Intake Form (2024)",
    "active": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({title: 'Patient Intake Form (2024)', active: true})
};

fetch('https://api.paubox.com/v1/forms/api/forms/{form_id}', 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.paubox.com/v1/forms/api/forms/{form_id}",
  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([
    'title' => 'Patient Intake Form (2024)',
    'active' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.paubox.com/v1/forms/api/forms/{form_id}"

	payload := strings.NewReader("{\n  \"title\": \"Patient Intake Form (2024)\",\n  \"active\": true\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.paubox.com/v1/forms/api/forms/{form_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"Patient Intake Form (2024)\",\n  \"active\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paubox.com/v1/forms/api/forms/{form_id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"Patient Intake Form (2024)\",\n  \"active\": true\n}"

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

{
  "detail": "Form updated successfully",
  "form_id": "550e8400-e29b-41d4-a716-446655440000"
}

Authorizations

Authorization

string

header

required

Paubox API key sent as Authorization: Bearer YOUR_API_KEY. API keys are created in the Paubox dashboard and must have the "forms" scope; a key without the forms scope receives 401 Unauthorized. A valid key used against a resource that belongs to a different customer receives 403 Forbidden.

Path Parameters

form_id

string<uuid>

required

UUID of the form to update

Body

application/json

Partial update. All fields are optional; omitted fields are left unchanged.

title

string

description

string

form_json

object

The form field schema

vanity_url

string

recipient

string

Comma-separated email addresses notified on each submission.

active

boolean

subscription_list_id

string

ID of the connected Marketing contact list. For marketing forms, new subscribers are added to this list.

Response

Form updated

detail

string

form_id

string<uuid>

⌘I

Email API · Messages

Email API · Dynamic templates

Marketing · Campaigns

Marketing · Drip campaigns

Marketing · Subscribers

Marketing · Subscription lists

Marketing · Tracking links

Marketing · Analytics

Forms API

Update a form

Authorizations

Path Parameters

Body

Response