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": "de19f0ed-fa8d-4239-8bc4-d401ef157f4f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2e836d52-0a0d-4af0-a301-97b5b3531187",
"company_code": "sample string 5",
"company": {
"id": "f79b649b-1b78-4e28-a137-276d142c4cd9",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-23T12:53:46.7472174+00:00",
"sales_territory_id": "bcc6a4c8-57de-4e49-80cf-dcb5bb8fe3b3",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "997c10f0-5514-43be-a49c-745ac97df47c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7db71f02-3516-434d-a5eb-19d20687732e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cb4defca-724c-4e18-8c66-e0a9f1481493",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c01135f-2c1f-4d8f-bbfa-b44fb3e0484d",
"db_currency_id": "0c04a708-f4d1-4db6-adfe-d200e7d898f8",
"db_language_id": "0b94ab91-9210-4a5a-8a62-23eff64b3a23",
"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-10-23T12:53:46.7472174+00:00"
},
"modified_dateutc": "2026-10-23T12:53:46.7472174+00:00"
},
"marketing_segment_id": "8380cabc-e78a-4695-8d79-568c876bd6d8",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "df071ea4-fccd-4726-a8db-d0de5f3a2a95",
"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": "6590b161-f071-4c70-95e0-2cec51006a36",
"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": "abc40bb0-0153-4c58-a980-dd2267cc8027",
"db_country_code": "sample string 28",
"feelist_id": "86ad231f-9ed3-4924-a6c1-8928e002413a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "452472aa-8086-4b02-954a-6d9443973e2e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "7d51bb55-1dd1-4a75-b4a1-c25f4aaebb9a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-23T12:53:46.7472174+00:00",
"db_currency_id": "a651be19-c5ed-4247-89f0-07670dfb7399",
"db_currency_code": "sample string 10"
},
"company_type_id": "3b76372f-5177-46d2-9b5c-244f4e95cdac",
"company_type_name": "sample string 32",
"company_type": {
"id": "2efca576-a56f-4f4d-b61d-af21d79f8695",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a8ca4712-bb9d-479e-97a6-4131cc19f6e7",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ae0ea4b1-e08b-4c45-8b2d-27e2d2594515",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "35944584-47c2-42eb-a724-2f5a483a1c44",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "fd379e05-97a2-4c27-9494-30e2c6992ae9",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7f34db40-34c1-4b97-aeda-f9446c42b14e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-23T12:53:46.7472174+00:00"
},
"company_sector_id": "29f67359-51d8-43a3-ae07-eb71abed2851",
"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": "15fd7a23-9020-4c9e-95c5-10472a67edbc",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f36f99da-0545-455e-beaf-752ff944be30",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "05e02fbd-a39e-4b32-9dfb-86740b46cf64",
"account_manager_user_code": "sample string 56",
"company_status_id": "7be7295b-562c-47de-ab63-b3d74d94fd36",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-23T12:53:46.760752+00:00",
"id2": 60
},
"db_language_id": "a41bab91-2209-4443-8f81-93214c844e30",
"db_language_code": "sample string 7",
"db_title_id": "def42763-cac9-4239-b365-6ecff24687e7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-23T12:53:46.760752+00:00",
"create_date": "2026-10-23T12:53:46.760752+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-10-23T12:53:46.760752+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.