applicationForm.submit

Submit an application for a job posting.

Requires the candidatesWrite permission.

The Content-Type of this request must be multipart/form-data.

Important: Please ensure that you check the response's success field and display any validation errors to candidates if it is false. Not doing so will result in applications not being recorded, without any notification to the candidate prompting them to resubmit. For testing purposes, you can simulate a validation failure by submitting the email address [email protected].

Note: The requests generated from this documentation will not work for this endpoint.

The values accepted for each field depend on the type of field that's being filled out:

  • Boolean - A boolean value
  • Date - A date string in the format YYYY-MM-DD
  • Email - A valid email address
  • Number - An integer
  • RichText - We do not support submitting rich text documents via the API but we do support submitting plain text values for these fields. Plain text values must be submitted in the format { type: "PlainText", value: "A plain text string" }
  • Score - An integer between 1 and 4 submitted in the format { score: 4 }
  • Phone, String A string
  • ValueSelect - A string that matches the value of one of the ValueSelect field's selectable options
  • MultiValueSelect - An array of strings that exist in the MultiValueSelect field's selectable options
  • Location - An object with the following properties: { country: "USA", city: "San Francisco", region: "California" }. You may provide any combination of these properties and we will attempt to geocode the location. For best results, provide all three properties.
  • EducationHistory - [Early Access] An array of objects with the following properties: { schoolName: "University of California, Berkeley", degree: "Bachelor of Science", major: "Computer Science", startDate: "2020-09-01", endDate: "2024-05-15", isCurrent: true }. Only schoolName is required. We will attempt to match the school name to a known school in our database. If isCurrent is true, endDate must not be provided.
Body Params
uuid
required

The id of the job posting to submit an application for

applicationForm
object
required
utmData
object
tagIds
array of uuids

The ids of the tags to apply to the candidate

tagIds
boolean

Defaults to true. If you are running a custom built careers page that is statically generated, you may want to set this to true to allow applications to be submitted in the time a job is unpublished and your careers page is refreshed. If set to false, applications submitted for unpublished job postings will return a job_posting_not_published error.

file

Any file referenced in the applicationForm. The name of this field must exactly match the value on the fieldSubmission that references this file.

Response

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