Allows you to create applications in Personio.

Log in to see full request history

POST body example

{ "job_position_id": 123, "first_name": "John", "last_name": "Doe", "email": "john.doe@email.com", "recruiting_channel_id": 250624, "external_posting_id": "4821b24c-8d85-11ec-b909-0242ac120002", "message": "new applicant message", "application_date": "2022-02-17", "tags": [ "tag1", "tag2", "tag3" ] "phase": { "type": "custom", // OR "system" "id": 26485 // if "tpye" is "system", then "id" is a string, e.g.: "offer" }, "files": [ { "uuid": "7d0f360a-8da3-11ec-b909-0242ac120002", "original_filename": "My CV.pdf", "category": "cv" }, { "uuid": "f4cc2da0-8da4-11ec-b909-0242ac120002", "original_filename": "code challenge.zip", "category": "work-sample" } ], "attributes": [ { "id": "birthday", "value": "1989-12-17" }, { "id": "gender", "value": "male" }, { "id": "location", "value": "Munich" }, { "id": "phone", "value": "000111222333" }, { "id": "available_from", "value": "As soon as possible" }, { "id": "salary_expectations", "value": "40k" }, { "id": "custom_attribute_1", "value": "attribute value" }, { "id": "custom_attribute_2", "value": "custom_option_7" }, { "id": "custom_attribute_3", "value": "2017-12-07" } ] }

Error Codes

codeMeaning
errors.attribute-validation.unknownThe supplied attribute was not found in our system.
errors.attribute-validation.required-attributeA required attribute was missing, null or blank.
errors.attribute-validation.invalid-date-formatThe supplied date attribute did not match the "ISO-8601 Local Date" format.
errors.attribute-validation.invalid-email-formatThe supplied email seems not to be valid.
errors.attribute-validation.invalid-typeThe supplied attribute type is not supported.
errors.attribute-validation.unknown-attribute-optionThe attribute value is not in the provided options.
errors.date-validation.date-in-the-futureInvalid application date.
errors.phase-validation.invalid-system-phaseThe supplied application phase is not supported.
errors.file-validation.file-not-existsThe supplied reference could not be resolved.
errors.invalid-file-typeThe supplied file is of an unsupported format.
errors.file-too-bigThe file size exceeded the configured limit
errors.applicant-already-existsWe could not verify that this email has not yet applied to this position.
errors.posting-validation.posting-not-foundThe job posting could not be found or did not match the supplied channel.
errors.posting-validation.channel-not-foundThe recruiting channel could not be found.
feature.recruiting.disabledYour company does not have access to Personio's recruiting features.
feature.public-api.disabledYour company does not have access to Personio's recruiting API.
Body Params
string
required
length ≥ 1

First name(s) of the applicant. Must not be empty or only whitespaces

string
required
length ≥ 1

Last name(s) of the applicant. Must not be empty or only whitespaces.

string
required

Email address of the applicant.

integer
required

The personio internal id of the job this application should belong to.

integer

The recruiting channel this application was sourced from.

See https://{YOUR_COMPANY}.personio.de/configuration/recruiting/channels

string

The external id of the job posting (E.g. the external id forwarded by Gohiring).

string

The applicant supplied free-text message.

date

The application date (yyyy-mm-dd). It cannot be a date in the future.

object

This can be a system or a custom application phase. When not provided, the application will be created with the initial phase according to the configuration for this job position's category (https://{YOUR_COMPANY}.personio.de/configuration/recruiting/categories).

When an invalid phase is provided (e.g. a non-existent custom phase or one that is not configured for this job position's category), the application will be created with the phase unassigned.

array of strings

Tags to be associated with this application. Non-existing tags will be created.

See https://{YOUR_COMPANY}.personio.de/configuration/recruiting/tags

tags
array of objects

References to previously uploaded files. These will be attached to the new application.

Each file item consists of a uuid, an original_filename and a category (To see exact description, click on "ADD OBJECT").

files
array of objects

Attributes for this applicant.

Each attribute item consists of an id and a value (To see exact description, click on "ADD OBJECT").

attributes
Headers
string

The partner identifier

string

The application identifier

string
required

Your company's Personio Id

Responses
201

Created - Application was created successfully.

401

Unauthorized - The API token and/or company id was not recognized. Please provide a valid API token in as value of an Authorization header, like Bearer api-token-value.

429

Too Many Requests - You have exceeded the rate-limit for your API call.

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