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": "5c8eca7f-42df-4a5c-8bcd-c80ce0baaaba",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e501e688-00f2-47d2-b026-8cb2ab024f9d",
"company_code": "sample string 5",
"company": {
"id": "337b9df9-55f2-4e82-b6ea-c871bb1e94a6",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-07T03:53:28.2412416+00:00",
"sales_territory_id": "6fb34013-35ca-45cd-bd5f-0ba2b2797135",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ccf476a0-b200-4993-b509-32b35df02ef9",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2bdfdb7f-f23e-4aff-b941-e98e758e6583",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cb7980ba-2c57-4eb3-bf6d-3aa4c0f3769a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5d4afd4b-6d8d-42b7-9e1f-07b650a2254b",
"db_currency_id": "64cb6122-deb2-4067-86f1-32e3f60c0ea2",
"db_language_id": "a544d37f-6d25-4c67-99a4-dd8504112581",
"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-09-07T03:53:28.2412416+00:00"
},
"modified_dateutc": "2026-09-07T03:53:28.2412416+00:00"
},
"marketing_segment_id": "a13150ab-4f6f-4190-b956-bf455e039400",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2329a9ac-e01c-434c-a5f4-1cb89575514c",
"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": "9326c453-677d-4975-9fa0-38f7feb85463",
"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": "b3334e9e-3c55-4ff5-b05e-e52c65cc516f",
"db_country_code": "sample string 28",
"feelist_id": "efde55f7-9dbf-4d77-84cd-ec5e004c7a2c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f9a96dd6-20b8-4cf4-806b-bafed018f5b9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c3712279-82da-47e1-8fdd-424445193df0",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-07T03:53:28.2412416+00:00",
"db_currency_id": "11e0aa3e-9cd9-4d09-8c93-30887115dc3e",
"db_currency_code": "sample string 10"
},
"company_type_id": "83459bb2-a06c-4726-b7cd-b01e42f996b7",
"company_type_name": "sample string 32",
"company_type": {
"id": "9d99ab56-bd15-4e4d-98b0-af758b3c6e85",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6191c6bc-3ab2-44a1-ae8c-a13fb6698f6a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "277f8a64-ffc4-4e1b-b729-d77029b9d28d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7c7c3738-833f-4226-8e04-7c7bcaf9db7d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "00d736f6-98ff-4115-a0f9-4109edd41ac8",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ff3d0443-9115-40e2-a40a-221ef524cebf",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-07T03:53:28.2412416+00:00"
},
"company_sector_id": "dfcf396c-7239-4976-a229-574244988763",
"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": "698df3f0-a7a1-47d7-b3b1-216a473cf64a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0407df79-6e60-4b22-a9c5-666cf12e0fe3",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "bbd63830-57a8-4a8d-9a52-304f4b2764b6",
"account_manager_user_code": "sample string 56",
"company_status_id": "110fa53e-9a25-4211-a0cf-5ab3fbdbc9b8",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-07T03:53:28.2412416+00:00",
"id2": 60
},
"db_language_id": "6f7f44fc-36c2-4587-8f67-95b3c744d89f",
"db_language_code": "sample string 7",
"db_title_id": "2ad49935-bebd-4edb-8a56-26a1886591a3",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-07T03:53:28.2412416+00:00",
"create_date": "2026-09-07T03:53:28.2412416+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-09-07T03:53:28.2412416+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.