intake-forms

Create an intake form

post/intake-forms

Request

  • Base URL: https://api.onplana.com/api
  • URL: https://api.onplana.com/api/intake-forms
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Headers

X-Organization-Idstring required

UUID of the active organization. Sets org context for all scoped operations.

Request body

namestring required
slugstring required

Globally-unique URL slug, used at /forms/{slug}.

descriptionstring
targetProjectIdstring uuid nullable
accessPasswordstring

Optional bcrypt-hashed password. Stored hashed; never returned.

isPublicboolean
notifySelfboolean
notifyUserIdsstring[]
notifyTeamIdsstring[]
fieldsobject[] required

Response

Form created

idstring uuid required
namestring required
slugstring required

Globally-unique URL slug. Public submission URL is /forms/{slug}.

descriptionstring nullable
isPasswordProtectedboolean
targetProjectIdstring uuid nullable
isPublicboolean
notifySelfboolean
notifyUserIdsstring[]
notifyTeamIdsstring[]
organizationIdstring uuid required
createdAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.