v1

latestOpenAPI 3.0.32026-08-06224144516.1 KB
Portals

Submit

Using this endpoint, you can submit a new application for a specific job on a portal.

The body of this request should have a fields key with an array of job application field objects as its value. To determine which fields need to be included in a call, see job application and job application fields. Each object can/should have the following keys/values:

  • id: (integer, required) All fields will have an id.

  • value: (string|boolean|object|null, required) All fields will also have a value. Text and text-like fields accept strings. File fields should be a base64 encoded string of your file as the value. Others only accept objects or booleans. See the examples below for all the different cases. You can find out what type a field is by fetching that field from job application fields.

  • filename: (string) This field is only used/required for file fields. Since files are passed at 64bit encoded strings with no name, you must pass a filename here.

See below for a full example with all field types.

post/portals/{portal_id}/jobs/{job_id}

Path parameters

portal_idnumber required

The ID of the portal the job being submitted to is on.

job_idnumber required

The ID of the job the application is being submitted for.

Request body

sourcestring

If the applicant is brand new to the system, what you provide in the source field will be set as their source. If they are not new to the system, their existing source will NOT be overwritten. If source is not provided it defaults to "Career Portal".

Response

Created