Skip to main content
PATCH
/
{version}
/
categories
/
{category}
/
forms
/
{form}
Update form
curl --request PATCH \
  --url https://api.perscom.io/{version}/categories/{category}/forms/{form} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "slug": "<string>",
  "is_public": false,
  "success_message": "<string>",
  "description": "<string>",
  "instructions": "<string>"
}
'
{
  "data": {
    "name": "<string>",
    "slug": "<string>",
    "is_public": false,
    "id": 123,
    "submission_status_id": 123,
    "success_message": "<string>",
    "description": "<string>",
    "instructions": "<string>",
    "label": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
version
enum<string>
default:v2
required

The API version to use.

Available options:
v1,
v2
​
category
integer
required
​
form
integer
required

Query Parameters

​
include
enum<string>
Available options:
fields,
submissions,
submissions.*,
tags

Body

application/json
​
name
string
required

The name of the form.

Maximum string length: 255
​
slug
string
required

The unique URL-friendly identifier for the form.

Maximum string length: 255
​
is_public
boolean
default:false
required

Whether the form is publicly accessible without authentication.

​
success_message
string | null

The message displayed after successful form submission. Supports HTML.

Maximum string length: 65535
​
description
string | null

A description of the form. Supports HTML.

Maximum string length: 65535
​
instructions
string | null

Instructions for completing the form. Supports HTML.

Maximum string length: 65535

Response

OK

​
data
FormResource · object