Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Application Form

applicationForm.submit

Submits a completed application form for a job posting.

Requires the candidatesWrite permission.

post/applicationForm.submit

Request body

jobPostingIdstring uuid required

The id of the job posting to submit the application for

tagIdsstring[] nullable

Optional array of tag ids to apply to the candidate

allowSubmissionForUnpublishedJobPostingboolean nullable required

If false, applications for unpublished job postings will be rejected. Defaults to true.

Example request

{
  "jobPostingId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "allowSubmissionForUnpublishedJobPosting": true
}

Response

Responses from the applicationForm.submit endpoint

OR

Example response

{
  "success": true,
  "results": {
    "submittedFormInstance": {
      "id": "7a3d9986-a88a-49f4-b363-8da21b893e30",
      "formDefinition": {
        "sections": [
          {
            "fields": [
              {
                "isRequired": true,
                "field": {
                  "id": "e7a0d858-963f-4964-b268-5271ad20dd59",
                  "type": "String",
                  "path": "_systemfield_name",
                  "humanReadablePath": "Name",
                  "title": "Name",
                  "isNullable": false
                }
              }
            ]
          }
        ]
      },
      "submittedValues": {
        "_systemfield_name": "Zod Baseline Applicant"
      }
    },
    "formMessages": {
      "blocked": false
    }
  }
}