Add candidate system data

curl --request POST \
  --url https://api.hyrd.de/gin/v1/company/candidate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
"{\n    \"phone\": \"+60147383114\",\n    \"email\": \"[email protected]\",\n    \"source\": \"\",\n    \"employee\": false\n}"
'

import requests

url = "https://api.hyrd.de/gin/v1/company/candidate"

payload = "{
    \"phone\": \"+60147383114\",
    \"email\": \"[email protected]\",
    \"source\": \"\",
    \"employee\": false
}"
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify('{\n    "phone": "+60147383114",\n    "email": "[email protected]",\n    "source": "",\n    "employee": false\n}')
};

fetch('https://api.hyrd.de/gin/v1/company/candidate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hyrd.de/gin/v1/company/candidate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode('{
    "phone": "+60147383114",
    "email": "[email protected]",
    "source": "",
    "employee": false
}'),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hyrd.de/gin/v1/company/candidate"

	payload := strings.NewReader("\"{\\n    \\\"phone\\\": \\\"+60147383114\\\",\\n    \\\"email\\\": \\\"[email protected]\\\",\\n    \\\"source\\\": \\\"\\\",\\n    \\\"employee\\\": false\\n}\"")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hyrd.de/gin/v1/company/candidate")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("\"{\\n    \\\"phone\\\": \\\"+60147383114\\\",\\n    \\\"email\\\": \\\"[email protected]\\\",\\n    \\\"source\\\": \\\"\\\",\\n    \\\"employee\\\": false\\n}\"")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyrd.de/gin/v1/company/candidate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "\"{\\n    \\\"phone\\\": \\\"+60147383114\\\",\\n    \\\"email\\\": \\\"[email protected]\\\",\\n    \\\"source\\\": \\\"\\\",\\n    \\\"employee\\\": false\\n}\""

response = http.request(request)
puts response.read_body

"{\n    \"message\": \"Candidate input successfully\",\n    \"status\": \"success\",\n    \"data\": {\n        \"slug\": \"335516d7-d3ed-4fce-924d-237d07832d58\"\n    }\n}"

Company > Candidate

Add candidate system data

POST /gin/v1/company/candidate

This endpoint allows the addition of a candidate to a company based on Company Id or authorization api key

Request Body

phone (string, optional): The phone number of the candidate. (Required if email is missing)
email (string, optional): The email address of the candidate. (Required if phone is missing)
source (string, optional): The source of imported candidate. If empty the result will be
employee (boolean, optional): Is this person an employee or a candidate ?. If empty the result will be false

Response

The response for this request can be represented as a JSON schema:

{
    "type": "object",
    "properties": {
        "message": {
            "type": "string"
        },
        "status": {
            "type": "string"
        },
        "data": {
            "type": "object",
            "properties": {
                "slug": {
                    "type": "string"
                }
            }
        }
    }
}

POST

gin

company

candidate

Add candidate system data

curl --request POST \
  --url https://api.hyrd.de/gin/v1/company/candidate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
"{\n    \"phone\": \"+60147383114\",\n    \"email\": \"[email protected]\",\n    \"source\": \"\",\n    \"employee\": false\n}"
'

import requests

url = "https://api.hyrd.de/gin/v1/company/candidate"

payload = "{
    \"phone\": \"+60147383114\",
    \"email\": \"[email protected]\",
    \"source\": \"\",
    \"employee\": false
}"
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify('{\n    "phone": "+60147383114",\n    "email": "[email protected]",\n    "source": "",\n    "employee": false\n}')
};

fetch('https://api.hyrd.de/gin/v1/company/candidate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hyrd.de/gin/v1/company/candidate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode('{
    "phone": "+60147383114",
    "email": "[email protected]",
    "source": "",
    "employee": false
}'),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hyrd.de/gin/v1/company/candidate"

	payload := strings.NewReader("\"{\\n    \\\"phone\\\": \\\"+60147383114\\\",\\n    \\\"email\\\": \\\"[email protected]\\\",\\n    \\\"source\\\": \\\"\\\",\\n    \\\"employee\\\": false\\n}\"")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hyrd.de/gin/v1/company/candidate")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("\"{\\n    \\\"phone\\\": \\\"+60147383114\\\",\\n    \\\"email\\\": \\\"[email protected]\\\",\\n    \\\"source\\\": \\\"\\\",\\n    \\\"employee\\\": false\\n}\"")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyrd.de/gin/v1/company/candidate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "\"{\\n    \\\"phone\\\": \\\"+60147383114\\\",\\n    \\\"email\\\": \\\"[email protected]\\\",\\n    \\\"source\\\": \\\"\\\",\\n    \\\"employee\\\": false\\n}\""

response = http.request(request)
puts response.read_body

"{\n    \"message\": \"Candidate input successfully\",\n    \"status\": \"success\",\n    \"data\": {\n        \"slug\": \"335516d7-d3ed-4fce-924d-237d07832d58\"\n    }\n}"

Headers

Authorization

string

Body

application/json

The body is of type object.

Response

Created

The response is of type string.

API Documentation

Users

General

Company > Candidate

Company > Api Integrations

Add candidate system data

POST /gin/v1/company/candidate

Request Body

Response

Headers

Body

Response