Update a request form

Updates an existing request form's configuration including name, description, activation state, custom property
override options, and associated template settings. Request forms define the structure and fields for
work requests that users submit to initiate programs or tasks. This endpoint allows administrators to
modify form metadata and behavior without recreating the form or affecting existing requests created
with this form.

Key Features:

  • Updates form display name and description for clarity in form selection interfaces
  • Modifies form activation state to control availability for new request submissions
  • Configures custom property overrides to tailor form fields for specific workflows
  • Adjusts form template associations for request-to-program conversion patterns
  • Preserves existing requests created with this form while updating the form definition
  • Maintains form ID and relationships while updating configurable attributes

Authorization Logic:

  1. User must have a valid JWT (JSON Web Token - a secure, stateless authentication token) with management scopes
  2. User must have permission to manage request forms in the space

Usage Example:

Update a form's display name and activate it: Call PUT /v2/spaces/w5PmrE9p0kicqqRSVJ3VBQ/forms/yS86zRG7smz7NVwdUEyJSj
with request body {"name": "Q1 Product Launch Request", "activated": true} to rename the form and make it available for users to submit requests. Deactivate a seasonal form by setting activated to false when the campaign period ends.

Path Params
string
required
length between 7 and 22

The unique identifier of the space containing the target entity. This determines the scope of entity queries and ensures proper access control. The space must be accessible to the authenticated user with appropriate permissions. It can be the unique identifier (GUID) of the space or the word "default" to indicate the default programs space. Common values include "default" and "rkr83lapKkyCJuLLWqLqzB".

string
required

The ID of the form.

Body Params

The request form data

customPropertyOverrideOptions
array of objects

Override options for custom properties

customPropertyOverrideOptions
string

Name of request form

string | null

Description of request form

boolean

Indicator on whether the form is active or not

Responses

Language
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json