Customer
Create a new customer
post/core/latest/customers
Request
- Base URL: https://api.klara.ch
- URL: https://api.klara.ch/core/latest/customers
- Auth: one of:
- API key in header X-API-KEY
- HTTP bearer
Request body
Example request
{
"id": "1",
"person": {
"website": "www.my-company.com",
"onlinePlatforms": [
{
"id": "1",
"platformName": "FACEBOOK",
"platformValue": "www.linkedin.com/abc"
}
],
"language": "en",
"responsibleCounterpart": "Mr. Marc",
"correspondence": "MAIL",
"id": "1",
"salutation": "MALE",
"firstName": "John",
"lastName": "Henry",
"birthday": "2020-01-20",
"addresses": [
{
"id": "1",
"addressLines": "Chemin de la Caquerette 12",
"addressType": "WORK",
"cityName": "Bern",
"cityZipCode": "3003",
"countryIso2Code": "CH",
"countryIso3Code": "CHE",
"countryNumericCode": "756",
"city_href": "https://api.klara.ch/core/latest/cities/1",
"definitionName": "2nd address",
"additionalAddress": "No. 13, street 123"
}
],
"phones": [
{
"id": "1",
"phoneNumber": "+41783334444",
"type": "PRIVATE"
}
],
"emails": [
{
"id": "1",
"emailAddress": "example@gmail.com",
"type": "PRIVATE"
}
]
},
"company": {
"website": "www.my-company.com",
"onlinePlatforms": [
{
"id": "1",
"platformName": "FACEBOOK",
"platformValue": "www.linkedin.com/abc"
}
],
"language": "en",
"responsibleCounterpart": "Mr. Marc",
"correspondence": "MAIL",
"id": "1",
"name": "ABC-Corp",
"phones": [
{
"id": "1",
"phoneNumber": "+41783334444",
"type": "PRIVATE"
}
],
"emails": [
{
"id": "1",
"emailAddress": "example@gmail.com",
"type": "PRIVATE"
}
],
"addresses": [
{
"id": "1",
"addressLines": "Chemin de la Caquerette 12",
"addressType": "WORK",
"cityName": "Bern",
"cityZipCode": "3003",
"countryIso2Code": "CH",
"countryIso3Code": "CHE",
"countryNumericCode": "756",
"city_href": "https://api.klara.ch/core/latest/cities/1",
"definitionName": "2nd address",
"additionalAddress": "No. 13, street 123"
}
],
"corporateIdentificationNumber": "CHE-123.456.789",
"vatNumber": "CHE-123.456.789",
"hrNumber": "CHE-123.456.789",
"nogaCode": "1234",
"foundingDate": "2019-12-20"
},
"priceCategory": "Sale price",
"customerType": "PERSON"
}Response
Customer created
Example response
{
"id": "1",
"person": {
"website": "www.my-company.com",
"onlinePlatforms": [
{
"id": "1",
"platformName": "FACEBOOK",
"platformValue": "www.linkedin.com/abc"
}
],
"language": "en",
"responsibleCounterpart": "Mr. Marc",
"correspondence": "MAIL",
"id": "1",
"salutation": "MALE",
"firstName": "John",
"lastName": "Henry",
"birthday": "2020-01-20",
"addresses": [
{
"id": "1",
"addressLines": "Chemin de la Caquerette 12",
"addressType": "WORK",
"cityName": "Bern",
"cityZipCode": "3003",
"countryIso2Code": "CH",
"countryIso3Code": "CHE",
"countryNumericCode": "756",
"city_href": "https://api.klara.ch/core/latest/cities/1",
"definitionName": "2nd address",
"additionalAddress": "No. 13, street 123"
}
],
"phones": [
{
"id": "1",
"phoneNumber": "+41783334444",
"type": "PRIVATE"
}
],
"emails": [
{
"id": "1",
"emailAddress": "example@gmail.com",
"type": "PRIVATE"
}
]
},
"company": {
"website": "www.my-company.com",
"onlinePlatforms": [
{
"id": "1",
"platformName": "FACEBOOK",
"platformValue": "www.linkedin.com/abc"
}
],
"language": "en",
"responsibleCounterpart": "Mr. Marc",
"correspondence": "MAIL",
"id": "1",
"name": "ABC-Corp",
"phones": [
{
"id": "1",
"phoneNumber": "+41783334444",
"type": "PRIVATE"
}
],
"emails": [
{
"id": "1",
"emailAddress": "example@gmail.com",
"type": "PRIVATE"
}
],
"addresses": [
{
"id": "1",
"addressLines": "Chemin de la Caquerette 12",
"addressType": "WORK",
"cityName": "Bern",
"cityZipCode": "3003",
"countryIso2Code": "CH",
"countryIso3Code": "CHE",
"countryNumericCode": "756",
"city_href": "https://api.klara.ch/core/latest/cities/1",
"definitionName": "2nd address",
"additionalAddress": "No. 13, street 123"
}
],
"corporateIdentificationNumber": "CHE-123.456.789",
"vatNumber": "CHE-123.456.789",
"hrNumber": "CHE-123.456.789",
"nogaCode": "1234",
"foundingDate": "2019-12-20"
},
"priceCategory": "Sale price",
"customerType": "PERSON"
}Changes
No recorded changes to this operation across all 1 revision of this API.