curl --request POST \
--url https://pre-partners-api.cobee.io/api/v3/companies/{companyId}/employees/{employeeId}/family-members \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Emma",
"surname": "Smith",
"type": "child",
"gender": "female",
"birthDate": "2018-04-12",
"nationality": "ES",
"legalId": "12345678Z",
"incapacityLevel": "33%"
}
'import requests
url = "https://pre-partners-api.cobee.io/api/v3/companies/{companyId}/employees/{employeeId}/family-members"
payload = {
"name": "Emma",
"surname": "Smith",
"type": "child",
"gender": "female",
"birthDate": "2018-04-12",
"nationality": "ES",
"legalId": "12345678Z",
"incapacityLevel": "33%"
}
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({
name: 'Emma',
surname: 'Smith',
type: 'child',
gender: 'female',
birthDate: '2018-04-12',
nationality: 'ES',
legalId: '12345678Z',
incapacityLevel: '33%'
})
};
fetch('https://pre-partners-api.cobee.io/api/v3/companies/{companyId}/employees/{employeeId}/family-members', 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://pre-partners-api.cobee.io/api/v3/companies/{companyId}/employees/{employeeId}/family-members",
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([
'name' => 'Emma',
'surname' => 'Smith',
'type' => 'child',
'gender' => 'female',
'birthDate' => '2018-04-12',
'nationality' => 'ES',
'legalId' => '12345678Z',
'incapacityLevel' => '33%'
]),
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://pre-partners-api.cobee.io/api/v3/companies/{companyId}/employees/{employeeId}/family-members"
payload := strings.NewReader("{\n \"name\": \"Emma\",\n \"surname\": \"Smith\",\n \"type\": \"child\",\n \"gender\": \"female\",\n \"birthDate\": \"2018-04-12\",\n \"nationality\": \"ES\",\n \"legalId\": \"12345678Z\",\n \"incapacityLevel\": \"33%\"\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://pre-partners-api.cobee.io/api/v3/companies/{companyId}/employees/{employeeId}/family-members")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Emma\",\n \"surname\": \"Smith\",\n \"type\": \"child\",\n \"gender\": \"female\",\n \"birthDate\": \"2018-04-12\",\n \"nationality\": \"ES\",\n \"legalId\": \"12345678Z\",\n \"incapacityLevel\": \"33%\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pre-partners-api.cobee.io/api/v3/companies/{companyId}/employees/{employeeId}/family-members")
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 \"name\": \"Emma\",\n \"surname\": \"Smith\",\n \"type\": \"child\",\n \"gender\": \"female\",\n \"birthDate\": \"2018-04-12\",\n \"nationality\": \"ES\",\n \"legalId\": \"12345678Z\",\n \"incapacityLevel\": \"33%\"\n}"
response = http.request(request)
puts response.read_body{
"id": "7f4c9ba8-9c2d-4b82-8b8c-e5f8f8f8f8f8",
"name": "Emma",
"surname": "Smith",
"type": "child",
"birthDate": "2018-04-12",
"legalId": "12345678Z",
"incapacityLevel": "33%"
}{
"message": "Invalid family member data"
}{
"message": "invalid_token"
}{
"message": "Company does not belong to the specified partner"
}{
"message": "Company or employee not found"
}{
"message": "Internal server error"
}[DRAFT] Create family member
curl --request POST \
--url https://pre-partners-api.cobee.io/api/v3/companies/{companyId}/employees/{employeeId}/family-members \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Emma",
"surname": "Smith",
"type": "child",
"gender": "female",
"birthDate": "2018-04-12",
"nationality": "ES",
"legalId": "12345678Z",
"incapacityLevel": "33%"
}
'import requests
url = "https://pre-partners-api.cobee.io/api/v3/companies/{companyId}/employees/{employeeId}/family-members"
payload = {
"name": "Emma",
"surname": "Smith",
"type": "child",
"gender": "female",
"birthDate": "2018-04-12",
"nationality": "ES",
"legalId": "12345678Z",
"incapacityLevel": "33%"
}
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({
name: 'Emma',
surname: 'Smith',
type: 'child',
gender: 'female',
birthDate: '2018-04-12',
nationality: 'ES',
legalId: '12345678Z',
incapacityLevel: '33%'
})
};
fetch('https://pre-partners-api.cobee.io/api/v3/companies/{companyId}/employees/{employeeId}/family-members', 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://pre-partners-api.cobee.io/api/v3/companies/{companyId}/employees/{employeeId}/family-members",
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([
'name' => 'Emma',
'surname' => 'Smith',
'type' => 'child',
'gender' => 'female',
'birthDate' => '2018-04-12',
'nationality' => 'ES',
'legalId' => '12345678Z',
'incapacityLevel' => '33%'
]),
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://pre-partners-api.cobee.io/api/v3/companies/{companyId}/employees/{employeeId}/family-members"
payload := strings.NewReader("{\n \"name\": \"Emma\",\n \"surname\": \"Smith\",\n \"type\": \"child\",\n \"gender\": \"female\",\n \"birthDate\": \"2018-04-12\",\n \"nationality\": \"ES\",\n \"legalId\": \"12345678Z\",\n \"incapacityLevel\": \"33%\"\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://pre-partners-api.cobee.io/api/v3/companies/{companyId}/employees/{employeeId}/family-members")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Emma\",\n \"surname\": \"Smith\",\n \"type\": \"child\",\n \"gender\": \"female\",\n \"birthDate\": \"2018-04-12\",\n \"nationality\": \"ES\",\n \"legalId\": \"12345678Z\",\n \"incapacityLevel\": \"33%\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pre-partners-api.cobee.io/api/v3/companies/{companyId}/employees/{employeeId}/family-members")
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 \"name\": \"Emma\",\n \"surname\": \"Smith\",\n \"type\": \"child\",\n \"gender\": \"female\",\n \"birthDate\": \"2018-04-12\",\n \"nationality\": \"ES\",\n \"legalId\": \"12345678Z\",\n \"incapacityLevel\": \"33%\"\n}"
response = http.request(request)
puts response.read_body{
"id": "7f4c9ba8-9c2d-4b82-8b8c-e5f8f8f8f8f8",
"name": "Emma",
"surname": "Smith",
"type": "child",
"birthDate": "2018-04-12",
"legalId": "12345678Z",
"incapacityLevel": "33%"
}{
"message": "Invalid family member data"
}{
"message": "invalid_token"
}{
"message": "Company does not belong to the specified partner"
}{
"message": "Company or employee not found"
}{
"message": "Internal server error"
}Overview
Creates a family member for a specific employee. The request requiresname, surname, type, gender, birthDate, incapacityLevel, and nationality. The public API currently supports child as the family member type. nationality must be an uppercase ISO 3166-1 alpha-2 country code, such as ES or PT.
legalId is optional for family members under 18 years old. It is required when the family member is 18 years old or older.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The unique identifier of the company
The unique identifier of the employee
Body
Family member data to be created. legalId is required when the family member is 18 years old or older.
The family member's first name
The family member's surname
The type of family member
child The family member's gender
male, female The family member's date of birth in ISO 8601 format (YYYY-MM-DD)
The family member's nationality as an ISO 3166-1 alpha-2 country code in uppercase
^[A-Z]{2}$"ES"
The family member's incapacity level
0%, 33%, 66% The family member's legal identifier. Optional for family members under 18 years old and required for family members aged 18 or older.
Response
Family member successfully created
The unique identifier of the family member
The family member's first name
The family member's surname
The type of family member
child The family member's gender
male, female The family member's date of birth in ISO 8601 format (YYYY-MM-DD)
The family member's nationality as an ISO 3166-1 alpha-2 country code in uppercase
^[A-Z]{2}$"ES"
The family member's incapacity level
0%, 33%, 66% The family member's legal identifier