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": "42b9eac1-e5be-438c-a380-b8ae7dd0a63f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "856e5e66-a256-4bc2-8100-570c52bca20a",
"company_code": "sample string 5",
"company": {
"id": "65e7ccd8-5c93-4e45-9535-2285015c44b7",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-26T06:43:50.8508721+00:00",
"sales_territory_id": "20a60973-d8d3-47cc-abf2-d3a7ede5d157",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b1b83d2b-6056-4963-9ba8-e18b95b96dfb",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f615ee0e-8557-4f4b-b324-9c051fa0f2ba",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3bac16ae-82d1-48b3-bbf4-68a909da14a3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a721df8c-19ed-4196-8b23-e46890bf2b24",
"db_currency_id": "84b185ea-c5ed-441d-b512-452979c2c4df",
"db_language_id": "facdf485-dfc5-455a-8097-c00cd5357498",
"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": "2025-12-26T06:43:50.8508721+00:00"
},
"modified_dateutc": "2025-12-26T06:43:50.8508721+00:00"
},
"marketing_segment_id": "82818d6d-2624-49c1-a1ba-26995a8a65b0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "58f95333-2799-4ad7-bf0b-6ae5a3623ebe",
"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": "8d082053-283a-4fa1-8780-5982e08afebd",
"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": "2043dbc9-74fb-4823-8beb-878cfa3c6c5b",
"db_country_code": "sample string 28",
"feelist_id": "4d77fc71-29be-4f5a-82be-8d92a9c05e49",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ee4af7b0-1347-4261-9c8b-f8b70f359ed9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f980cdde-101c-4628-bda1-1ce8d799e192",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-26T06:43:50.8508721+00:00",
"db_currency_id": "24322311-cb79-4dd8-86bc-a8de2bab6b03",
"db_currency_code": "sample string 10"
},
"company_type_id": "bc17c23c-7e25-4181-a4a0-ba18b0b69eb3",
"company_type_name": "sample string 32",
"company_type": {
"id": "81bc43f6-e549-4219-a252-327925a1694e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f6c8a3aa-28ca-4874-8833-fb1cf74704cc",
"sales_organization_code": "sample string 5"
},
"db_language_id": "127da044-91b3-444d-ac4d-dbe5428eb85c",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7943e7a4-b1f3-4afb-97e9-a608d60f1c5e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "54310a49-5345-4eb7-85c8-70c135dadd16",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "80303d57-0482-45a2-b8e7-e1005a3f0aa8",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-26T06:43:50.8508721+00:00"
},
"company_sector_id": "fd734c53-59b9-44f4-996b-b45176d5e7dd",
"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": "9cbb21e4-6c50-421d-b6e1-7962c8cce03d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1f15e4d9-af5e-412c-bdb1-7a3da0df2233",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "41fbc490-7d3a-4ab1-a88d-b57f6a8ce866",
"account_manager_user_code": "sample string 56",
"company_status_id": "75522abc-0a70-40af-8bfe-11129958ad17",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-26T06:43:50.8508721+00:00",
"id2": 60
},
"db_language_id": "e1b1ec10-6267-4c8c-865c-84161ce34a08",
"db_language_code": "sample string 7",
"db_title_id": "d816d6ad-c1c7-4439-bea3-4ca952aa524d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-26T06:43:50.8508721+00:00",
"create_date": "2025-12-26T06:43:50.8508721+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": "2025-12-26T06:43:50.8508721+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.