Create a request form

Create a new request form within a space to enable users to submit structured requests for content, programs, or tasks. Request forms define the fields, validation rules, and workflow configurations that govern how users submit and process requests in the workspace. When creating a form, you specify the form name, activation status, field definitions, and optional custom properties that capture organization-specific metadata.
Use this endpoint to standardize request intake processes, establish consistent data collection patterns, and enable self-service workflows where team members can initiate programs or tasks by completing forms. Common scenarios include creating 'Content Request Form' with activated=true to immediately enable content submissions, 'Program Proposal Form' with custom approval fields for initiative planning, or 'Training Request Form' with participant count and scheduling fields for learning management.
The created form becomes immediately available in the space (if activated=true) and appears in form selection interfaces, request creation workflows, and administrative form management views. Users with appropriate permissions can submit requests using the form, triggering automated workflows, task creation, or program instantiation based on your form configuration. Forms support custom properties, conditional logic, field validation, and integration with space-specific taxonomies and metadata schemas.

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".

Body Params

The request form data

string

Human-readable display name for the request form shown in form selection interfaces, submission workflows, and administrative management views. Typically 3-100 characters clearly identifying the form's purpose such as 'Content Request Form', 'Program Proposal Submission', or 'Training Request Intake'. Required field that should be unique within the space for clarity, though uniqueness is not enforced. Appears as the form title when users browse available forms and serves as the primary identifier in form listings. Use descriptive names that convey the request type and purpose to help users select the appropriate form without additional context.

string | null

Detailed explanatory text describing the request form's purpose, intended use cases, submission guidelines, and any special instructions for users completing the form. Optional field (nullable) supporting multi-line plain text, typically 50-500 characters. Appears in form selection interfaces as supporting context, helps users determine if this form meets their needs, and may include information about approval workflows, typical turnaround times, or prerequisites. Examples include 'Use this form to request new marketing content creation with required approval from department head' or 'Submit training requests at least 2 weeks in advance for scheduling coordination'. Can be null if the form name is sufficiently self-explanatory.

customPropertyOverrideOptions
array of objects

Array of CustomPropertyOverrideOption objects that customize how space-level custom property definitions behave specifically within this form. Each option can override the default custom property configuration by adjusting display order, field requirement status (making optional fields required or vice versa), hint text shown to users, and field visibility. Enables form-specific field behavior without modifying the underlying space custom property definitions used elsewhere. For example, make a 'Budget Code' custom property optional at the space level but required in financial request forms, or change the display order to prioritize high-priority fields at the top of this form. Empty array or omit when using default custom property configurations without form-specific overrides.

customPropertyOverrideOptions
boolean | null

Boolean flag controlling whether the newly created form is immediately active and available for users to submit requests. When true, the form appears in form selection interfaces immediately upon creation and users with appropriate permissions can begin submitting requests. When false or null (defaults to false), the form is created in deactivated state requiring explicit activation via PUT /v2/spaces/{spaceId}/forms/{formId}/activate before becoming usable. Set to false when creating forms that require additional configuration, testing, or approval before making them available to users. Set to true for forms that are ready for immediate production use. Nullable field where null is treated as false for backward compatibility.

Responses

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