Create Form

post

https://{subdomain}.ingenious.build/api/v2/pub/forms

Creates a form in draft or completed state

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

project_id

string

required

The project ID to which the form belongs.

form_template_id

string

required

The form template ID.

status

string

enum

required

The form status. Either draft or completed.

Allowed:

originator_id

string

required

Person ID of the form originator. Persisted as created_by.

date

required

The form date. Date in Y-m-d format.

answers

array of objects

required

Answers keyed by stable question/option IDs.

answers*

completed_by_id

string | null

Defaults to null

Person ID that completed the form. Required when status is completed, forbidden for draft.

completion_date

date-time | null

Defaults to null

Completion date (UTC). Required when status is completed, forbidden for draft.

title

string | null

Defaults to null

Title of the form. Defaults to the template name when omitted.

Responses

201

Successful operation

400

Bad Request

401

Unauthorized

403

Forbidden

404

Form template not found

422

Unprocessable entity

500

Internal server error

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here!