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": "06170bad-466c-45ee-913e-4009f48962be",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3cc7a38f-f32e-4023-bfa0-849d1589aad3",
"company_code": "sample string 5",
"company": {
"id": "a1220179-789b-4b46-8f52-b77a15398e5f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-02T04:55:54.9744264+00:00",
"sales_territory_id": "cbe83258-a71b-40fd-901c-fc2e28a69a29",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f7863666-d9a4-467f-927c-ce32db27f62c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e8917a3d-fc8f-432c-af5f-6bd47078d3f3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5b6a4190-a7f7-4326-bbd5-c249fcc45ce2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6879ceb-3c3d-47fd-a693-a37ad671b265",
"db_currency_id": "d99aa90f-58d7-493e-937a-e267732e9ec5",
"db_language_id": "13cb217b-4fe2-44c6-9f89-dac9cbae0b34",
"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-11-02T04:55:54.9744264+00:00"
},
"modified_dateutc": "2026-11-02T04:55:54.9744264+00:00"
},
"marketing_segment_id": "866d4d04-ac76-4e1d-ace3-7b3d2328161e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "73c8d60c-f5db-44ea-9785-9853575d4138",
"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": "5ec85ce8-3fdc-4660-a7df-5b7509388ce7",
"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": "e28f02f6-a9af-454e-b3e1-5906b932934f",
"db_country_code": "sample string 28",
"feelist_id": "b86d5683-fc0b-4d71-8161-4400dfb73900",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d4e889dd-a94f-4aa3-bda3-bd7bb2dcdcce",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "697ab287-f7ac-4ec5-8349-b8ef99cc26d8",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-02T04:55:54.9744264+00:00",
"db_currency_id": "68ea3b82-a69d-4ee8-9126-1ac0e86eeb42",
"db_currency_code": "sample string 10"
},
"company_type_id": "6c61c988-3860-4103-ae52-63013139b234",
"company_type_name": "sample string 32",
"company_type": {
"id": "07332917-e1b9-4120-8929-da8eeeb436a3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b40ba6b3-56e5-4e81-874c-73d928aadc0f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "674a7999-275a-494d-b2b8-30fb09240388",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a3da87de-1620-4f46-b492-01d4eae94f7f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "2ef17790-f313-4f2e-a172-2c5d05293594",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5a38ed0e-15f9-4b4b-945c-341789300053",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-02T04:55:54.9744264+00:00"
},
"company_sector_id": "355ad12e-9952-4311-a2b7-85229ee9ba2e",
"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": "b426385d-c537-4595-8953-ab95d2af9bd2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f0f444b1-c881-44d7-9a1a-944f92719574",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "74a24e3a-bb04-4c68-8455-2549a744e30f",
"account_manager_user_code": "sample string 56",
"company_status_id": "541635d2-d0d9-4434-8679-1321d7a5a1ad",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-02T04:55:54.9744264+00:00",
"id2": 60
},
"db_language_id": "020c826e-78f6-446a-a8fe-682e74739c2a",
"db_language_code": "sample string 7",
"db_title_id": "9a0d6351-2aed-493b-a20c-e98a6b7f5b41",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-02T04:55:54.9744264+00:00",
"create_date": "2026-11-02T04:55:54.9744264+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-11-02T04:55:54.9744264+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.