Sign in
Forms

Create a new Form

OAuth Scope

This endpoint requires the following OAuth scope manage_forms.

Record UUID

UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the x-record-uuid response header.

post/form.json

Request body

namestring

The name of the form. Used to identify the form in the system and displayed to users in the form selector. Must be unique within an account. Maximum length is 255 characters.

document_template_uuidstring uuid

UUID of the document template associated with this form. The template defines the layout and appearance of the form when it's generated as a document. References a document template object in the system.

can_be_used_independentlystring

Boolean flag indicating whether this form can be used independently of a job. When set to true (1), the form can be filled out as a standalone form. When false (0), the form must be associated with a job to be completed.

badge_mandatory_statestring

Controls when badge completion is mandatory for this form. Valid values are: 0 (not mandatory), 1 (mandatory on check-in), 2 (mandatory on check-out). This determines at which stage in the job lifecycle a staff member must complete this form.

uuidstring uuid

Unique identifier for this record

badge_namestring

Example request

{
  "document_template_uuid": "123e4567-d046-4b70-a4b1-23f940b4d8bb",
  "uuid": "123e4567-17b5-4ac7-b4e1-23f945950bab"
}

Response

Success

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes

Changed in 4 of the 50 revisions of this API.16

  • 638a8df09bf41See the full diff
    • ●

      removed the request property active

      request-property-removed

  • ca9b053c43734See the full diff
    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    • ○

      added the non-success response with the status 429

      response-non-success-status-added

    • ○

      added the non-success response with the status 500

      response-non-success-status-added

  • d847d5089d6d1See the full diff
    • ○

      the security scope manage_forms was added to the endpoint's security scheme oauth2

      api-security-scope-added

  • 10aa4962e80d1See the full diff
    • ○

      added the new optional request property badge_name

      new-optional-request-property