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": "d93cb519-e845-4ab5-be76-4d49c6e9a3f2",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d9f9b2e0-5f26-47a5-9e53-83cf9e55312b",
"company_code": "sample string 5",
"company": {
"id": "eb8d3448-4504-4361-9091-234d5a81e93d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-05T23:48:03.1220586+00:00",
"sales_territory_id": "c45ee093-d3ad-4ef2-81f2-d775336b0fa6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "98f35855-c101-4d13-9796-859616d9b143",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ffe014ac-686e-438d-86aa-bfc49ed99a6e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2d36191f-3bf9-4c19-aa03-cec907f31140",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f82f2560-af04-40f9-bd1b-d7725ab0eb18",
"db_currency_id": "f9095528-1b75-40e3-b507-f556ed44e0fa",
"db_language_id": "e6aff308-6950-485f-af95-585bbd06e89b",
"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-03-05T23:48:03.1376804+00:00"
},
"modified_dateutc": "2026-03-05T23:48:03.1376804+00:00"
},
"marketing_segment_id": "3089b48b-2512-429d-b533-4bcc15b28c77",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "53d250ab-3468-42f6-8264-60bfc274a465",
"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": "5e882deb-e1ad-4d71-a3a7-f490300739f5",
"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": "b82d99a4-b4a3-430d-8896-a0c20e774f47",
"db_country_code": "sample string 28",
"feelist_id": "03624556-48a2-4889-aad1-b492a89f389f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e8c15977-d31f-41bc-83a2-e4c1c37904b9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f1968c06-6165-4699-8456-fcfe6ce64542",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-05T23:48:03.1376804+00:00",
"db_currency_id": "fb514919-a639-4976-bd2b-e2ab0ed56a4e",
"db_currency_code": "sample string 10"
},
"company_type_id": "9d640038-3721-4fa0-9753-9714e258ef4d",
"company_type_name": "sample string 32",
"company_type": {
"id": "e270e3ec-8940-410e-8242-cdb127a8d00b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6df9adf8-ce3d-4938-be57-633b1f3b7a2a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b366cbc5-05a9-4456-9d13-899606446483",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5dbca2bc-4d2b-40c1-8499-78890a7054ed",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4dbae005-b322-48f6-9497-92f9c8c711f7",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "434777ff-52ad-4155-b7ef-413c49bb3dd5",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-05T23:48:03.1376804+00:00"
},
"company_sector_id": "60021adb-0062-45bb-9f35-ce87f903fc48",
"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": "566ca3f0-ba91-4f71-ab36-e7d2c527cc82",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8706f816-efad-40ab-b7ee-1ad489f14455",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "7a15194d-ad65-447d-81e0-6c1717b5670d",
"account_manager_user_code": "sample string 56",
"company_status_id": "c69faf7b-6796-49e1-8319-082ed43a5aaf",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-05T23:48:03.1376804+00:00",
"id2": 60
},
"db_language_id": "7430a0d2-ecb3-49de-9300-df12d8fea6b6",
"db_language_code": "sample string 7",
"db_title_id": "f385c8e7-c390-4f47-8db4-d376836ebf49",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-05T23:48:03.1376804+00:00",
"create_date": "2026-03-05T23:48:03.1376804+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-03-05T23:48:03.1376804+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.