Candidates

Creating new candidate within Midlane

Creating a new candidate

Create candidate.

POST https://app.midlane.com/api/public/candidates

Either the mobilePhoneNumber or the email parameter needs to be sent in order to create a candidate. It is also possible to send both.

If you send none, an error will be thrown.

Request Body

Name	Type	Required	Validation
firstName	string
lastName	string
email*	string		Valid email e.g. [email protected]
mobilePhoneNumber*	string		Valid mobile phone number e.g. [phone]
hiredAt	string		Date in ISO format YYYY-MM-DD
dateOfBirth	string		Date in ISO format YYYY-MM-DD
gender	string		MALE, FEMALE, NON_BINARY or NOT_SPECIFIED
citizenship	string		Country code e.g. DE
street1	string
houseNumber	string
street2	string
city	string
zipCode	string
state	string
country	string		Country code e.g. DE

201 Candidate successfully created

{
    "data": {
        "id": "cm8q6x4u2004r9y6my6tvllhq",
        "firstName": "John",
        "lastName": "Doe",
        "email": "[email protected]",
        "mobilePhoneNumber": "[phone]",
        "jobTitle": "Software Engineer",
        "hiredAt": "2024-03-15T00:00:00.000Z",
        "dateOfBirth": "1990-07-20",
        "gender": "MALE",
        "citizenship": "DE",
        "street1": "Main Street",
        "houseNumber": "42A",
        "street2": "Apt 4B",
        "city": "Berlin",
        "zipCode": "10115",
        "state": "Berlin",
        "country": "DE"
    }
}

400 Bad Request