Form Update

put

https://{serverUrl}/app/api/v1/kapps/{kappSlug}/forms/{formSlug}

Updates the Form specified by the {formSlug} parameter with the property values sent in the request body.

NOTE All properties in the request body are optional, and only the properties supplied will be updated.

The user must have Form creation privileges to perform this action.

Path Params

kappSlug

string

required

The slug of the Kapp

formSlug

string

required

The slug of the form

Query Params

restorationToken

string

The restorationToken property returned by the Search Forms action and setting the archived parameter.

Functions similarly to the regular Update Form action, except for archived (deleted) forms.

It can be passed the same body content as a regular Update Form action, which is helpful if an archived form needs to be restored when there is an active form with the same slug.

This action automatically transitions the form from archived (deleted) to active.

The user must be a space admin when using this parameter.

include

string

comma-separated list of properties to include in the response

details
attributes
attributes[ATTRIBUTE NAME]
attributesMap
attributesMap[ATTRIBUTE NAME]
bridgedResources
categorizations
customHeadContent
fields
fields[FIELD NAME]
pages
securityPolicies
kapp
kapp.{any kapp include property}

Body Params

The content for the form properties to update

Only the properties supplied will be updated.

name

string

slug

string

anonymous

boolean

description

string

status

string

type

string

notes

string

submissionLabelExpression

string

attributesMap

object

bridgedResources

array of objects

bridgedResources

categorizations

array of objects

categorizations

customHeadContent

string

fields

array of objects

fields

kapp

object

pages

array of objects

pages

securityPolicies

array of objects

securityPolicies

Response

Language

Credentials

Basic

base64

URL

Response

Choose an example:

application/json

200OK