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.
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!