Create a new person
POST
/peopleLast modified: 2 months ago
Request
Header Params
X-Integration-Name
string
required
Integration name
Example:
API Documentation
X-Integration-Provider
string
required
Integration provider
Example:
cobra GmbH
X-Cobra-TenantId
string
required
Tenant ID
Example:
12e39e53-ece1-4d8d-8958-e782de1dbef0
X-Integration-Contact
string
optional
Integration contact
Example:
info@cobra.de
Accept-Language
string
optional
Example:
de
Body Params application/json
Represents a DTO for creating a person.
salutation
string | null
optional
The salutation of the person.
title
string | null
optional
The title of the person.
<= 200 characters
firstname
string | null
optional
The first name of the person.
<= 200 characters
lastname
string | null
optional
The last name of the person.
<= 200 characters
birthday
object (PeopleBirthdayDto)
optional
birthday
required
The Birthday of the person.
The birthday may be a maximum of up to 130 years in the past or is today.
Example:
"0001-01-01"
considerBirthYear
boolean
optional
The flag to consider the birth year.
If the year of birth is not considered, the value must be 1584.
importantDates
$ref(#/definitions/1579186)[] | null
optional
The list of important dates.
#/definitions/1579186
optional
socialMedias
$ref(#/definitions/1579196)[] | null
optional
The List of social media accounts.
#/definitions/1579196
optional
orgaTags
array[object (CobraTagForEmbeddedDto) {2}] | null
optional
The List of orga tags.
id
string | null
optional
text
string | null
optional
<= 200 characters
personalities
$ref(#/definitions/1579162)[] | null
optional
The List of personalities.
#/definitions/1579162
optional
customerNumber
string | null
optional
Represents the customer number.
<= 200 characters
employeeStatus
string | null
optional
The employee status of the person.
employeeNumber
string | null
optional
The employee number of the person.
lifecycle
#/definitions/1579187optional
Example
Not configured
Request samples
Responses
Created(201)
Bad Request(400)
HTTP Code: 201
Content Type : JSONapplication/json
Data Schema
No schema defined
Example
Not configured
Last modified: 2 months ago