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": "65d0d62b-dcfa-4333-b3dd-a14928336274",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c42d5c9a-aa3c-4987-be06-2fccd545b61d",
"company_code": "sample string 5",
"company": {
"id": "0ac48612-4762-4151-a48a-8164941f7f59",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-20T07:36:17.3574504+00:00",
"sales_territory_id": "d2a7774d-f4e6-48f8-bde8-46d9e8e61d46",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "578ca1a5-2e3f-41c1-95cc-d06e10778377",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a9d1df1b-4939-4c48-8d3a-86f7c736a9d2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9ae4cdb2-6ec8-4852-a74f-ecae869c8f1a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a45dbe13-1605-4de9-88d8-4187d560ebf0",
"db_currency_id": "e0fae5f3-80b5-43f9-bfb4-bdc4927a19c0",
"db_language_id": "7d82eed3-c6d1-4705-bd70-8c1997f4c4d3",
"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-20T07:36:17.3574504+00:00"
},
"modified_dateutc": "2026-10-20T07:36:17.3574504+00:00"
},
"marketing_segment_id": "41e90afc-0a8b-4681-bd92-ae0c718d9949",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2e7cf496-7a9c-4b94-b323-3e20b1d9dc65",
"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": "5baaa52b-d39a-4d87-a9f1-b97c91a15e33",
"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": "783a8acd-ce82-4bf6-a433-a3a9612f02c1",
"db_country_code": "sample string 28",
"feelist_id": "a3a7b6b8-f1c0-49e5-bc21-5c7e97cc2832",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1412576a-637b-4c70-b834-6b9d114d64c7",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a6632afc-a45f-4208-a2f8-bcff3dda14ce",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-20T07:36:17.3574504+00:00",
"db_currency_id": "0984acf2-7454-4b52-8794-b9f67aedb5b0",
"db_currency_code": "sample string 10"
},
"company_type_id": "15e05451-c823-4ed4-9313-7eb98038d241",
"company_type_name": "sample string 32",
"company_type": {
"id": "244b6fed-8f1b-4a8c-8063-b236ed886541",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2e974168-5b1e-4063-8810-20b71d87704a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e7578dae-45a9-4568-b600-22750a1fff77",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "335f3f7d-cc9d-48f6-bdf1-970f9a005abc",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "11940ecb-a50f-4817-bb5f-859a4a0e5f5e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0e87c19a-2fb1-4c02-b021-a4d905e3ba43",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-20T07:36:17.3574504+00:00"
},
"company_sector_id": "addb4cb1-6d88-43d9-bf8b-ce0b9e82bf71",
"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": "a93fe92f-d7f8-4dd4-9918-3fe4a0107eee",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "390b4a7e-137f-41db-8e89-cecc965f0f9a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3bf7a8d6-7900-4003-bb1a-3e3f47060f87",
"account_manager_user_code": "sample string 56",
"company_status_id": "c949d33d-70bf-43bf-84cc-865d9c2e5355",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-20T07:36:17.3574504+00:00",
"id2": 60
},
"db_language_id": "454c21fa-0ecf-4e10-bb3e-97fb60abae41",
"db_language_code": "sample string 7",
"db_title_id": "badf014a-8aad-400f-ac67-a4cfdb7bc0f6",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-20T07:36:17.3574504+00:00",
"create_date": "2026-10-20T07:36:17.3574504+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-20T07:36:17.3574504+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.