Creates a new contact object
Request Information
URI Parameters :
None.
Body Parameters :
contact| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary key |
globally unique identifier |
Required |
| firstname |
Firstname of the contact |
string |
Max length: 50 |
| lastname |
Lastname of the contact. If you have one single field available for firstname+lastname then use Lastname |
string |
Required Max length: 50 |
| company_id |
Company of the contact |
globally unique identifier |
Optionally required : company_id,company_code or company must be provided |
| company_code |
Embedded entity "company" using ERP PK when adding/updating contact |
string |
Optionally required : company_id,company_code or company must be provided |
| company |
Embedded entity "company" when adding/updating contact |
company |
Optionally required : company_id,company_code or company must be provided |
| db_language_id |
Language of the contact.If empty, will use the default on the system |
globally unique identifier | |
| db_language_code |
Language code entity using international isocode when adding/updating contact |
string | |
| db_title_id |
The title of the contact |
globally unique identifier | |
| archived |
Archive this contact to not have it anymore on the search |
boolean | |
| functions |
Function of the contact (ServiceManager,...) |
string |
Max length: 64 |
| e_login |
Login of the contact (if have access to ServiceDesk) |
string |
Max length: 50 |
| e_password |
Password in clear text of the contact (if have access to ServiceDesk) |
string |
Max length: 50 |
| notes |
Notes/Remark field |
string | |
| birthdate |
Birthday date |
date | |
| create_date |
Creation date+time |
date | |
| phone |
Phone number of the contact |
string |
Max length: 50 |
| mobile |
a number of the contact |
string |
Max length: 50 |
|
|
string |
Max length: 250 |
|
| skype |
skype |
string |
Max length: 250 |
| private_phone |
Private phone number of the contact |
string |
Max length: 50 |
| private_mobile |
Private mobile number of the contact |
string |
Max length: 50 |
| private_email |
Private email |
string |
Max length: 250 |
| reference_back_office |
Field used for Embedded entity (store there your ERP PK) |
string |
Max length: 50 |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Request Formats :
application/json, text/json
Sample:
{
"id": "0f35d3be-21c7-4b39-a818-fa53df65ad79",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b8d5dc7e-f94c-45fa-93c4-2878eff38fc6",
"company_code": "sample string 5",
"company": {
"id": "426c5fde-9517-44d7-8992-be2ad880ae94",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-21T09:22:20.405699+00:00",
"sales_territory_id": "66b6ef5a-116d-4b0d-8ba2-b830988eebd8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "de24c34a-893f-4193-8d2c-d37590f74107",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b415de59-0a91-4880-8417-4e69f47b7c0b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "34739cbd-7538-4891-8b25-fe48080a4d71",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "545eae64-e545-4a95-ac64-d43d62a448cf",
"db_currency_id": "91a87a34-2b86-4f5c-9f27-64bb6b1932d7",
"db_language_id": "67d5b0ca-105e-46ee-91eb-72f2ebed5a41",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-05-21T09:22:20.405699+00:00"
},
"modified_dateutc": "2026-05-21T09:22:20.405699+00:00"
},
"marketing_segment_id": "a2ba37d0-5f57-4252-bcc1-daf01aade5da",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "8cad17ad-9629-4fb6-8d4b-1c606399b328",
"sales_organization_code": "sample string 13",
"company_sales_status_code": "sample string 14",
"vat_reg_code": "sample string 15",
"is_working_address": true,
"parent_id": "3be43711-5209-4766-a183-5c079c8ce60e",
"parent_company_code": "sample string 18",
"phone": "sample string 19",
"fax": "sample string 20",
"url": "sample string 21",
"email": "sample string 22",
"street": "sample string 23",
"street_number": "sample string 24",
"city": "sample string 25",
"zip": "sample string 26",
"db_country_id": "4730c510-ea96-4fe6-89db-543b4aea40a7",
"db_country_code": "sample string 28",
"feelist_id": "1338b60d-4d6e-4fcb-a47b-f6a15ecb8b74",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "63f6d69a-881a-45e4-a142-b1c48158fe9e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0b589fa6-3842-408f-a384-221b8381cbde",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-21T09:22:20.405699+00:00",
"db_currency_id": "35fb0281-086c-42c8-8795-9e49806e00b1",
"db_currency_code": "sample string 10"
},
"company_type_id": "6181d0f0-9688-4647-bf03-e99d7bb98460",
"company_type_name": "sample string 32",
"company_type": {
"id": "730c41b5-19de-4126-b2e6-82a80b0ea2ff",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e0de32d7-9b09-40f6-b358-ea0daf1f06de",
"sales_organization_code": "sample string 5"
},
"db_language_id": "484aef1e-24e2-46fd-8f18-a3d334a7cee5",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a559de0a-74df-483f-b3b9-bed5131de81b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "2d8973e1-d018-4d00-b5fc-233f2258f884",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "756f8d3b-d20b-4525-8bdd-979796e10666",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-21T09:22:20.405699+00:00"
},
"company_sector_id": "096469e5-f715-4446-91e2-3a5eabb9164b",
"company_sector_code": "sample string 41",
"is_lead": true,
"is_subcontractor": true,
"latitude": 1.0,
"longitude": 1.0,
"street2": "sample string 44",
"bic_code": "sample string 45",
"specialities": "sample string 46",
"register_number": "sample string 47",
"register_city": "sample string 48",
"bankaccount": "sample string 49",
"mobile": "sample string 50",
"service_manager_user_id": "cf2e1d61-9388-44f8-b304-3a36739df9ec",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "fe7e9abb-cd46-4f67-bbd0-ed65e990946a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "5b2e800c-d6cb-490b-a236-00d918ae7b91",
"account_manager_user_code": "sample string 56",
"company_status_id": "58731139-4751-4a8a-9a29-04116f4cdff3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-21T09:22:20.405699+00:00",
"id2": 60
},
"db_language_id": "42501500-6cd4-4cf2-bab5-76f17b95386d",
"db_language_code": "sample string 7",
"db_title_id": "2f44f7b5-57c7-4a7e-b736-7532c597e8c1",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-21T09:22:20.405699+00:00",
"create_date": "2026-05-21T09:22:20.405699+00:00",
"phone": "sample string 16",
"mobile": "sample string 17",
"email": "sample string 18",
"skype": "sample string 19",
"private_phone": "sample string 20",
"private_mobile": "sample string 21",
"private_email": "sample string 22",
"reference_back_office": "sample string 23",
"modified_dateutc": "2026-05-21T09:22:20.405699+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.