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": "fc2915e6-a883-414a-ba12-95272cfdb6e4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b2be78d8-8a7d-45f5-8734-9167c9999288",
"company_code": "sample string 5",
"company": {
"id": "65ce7c5b-aea3-48a7-b139-0720a8c57025",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-06T00:21:52.6271799+00:00",
"sales_territory_id": "952f14a0-9bf9-48c9-ad19-d482cca537b6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "fd7a61ae-db43-42a4-9495-dd45b27b6423",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "73f3fa57-4b2c-4f3f-8d4d-fa6dab67334f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2cca9b1b-8610-40cb-8c63-f266bfab8275",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f6183eda-4280-4749-8dea-0f2f3bcaeea8",
"db_currency_id": "89469a47-d3bf-4a2c-bafd-e701aa494de7",
"db_language_id": "7cdfc415-cba5-4d92-9333-e001f64259eb",
"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-11-06T00:21:52.6271799+00:00"
},
"modified_dateutc": "2025-11-06T00:21:52.6271799+00:00"
},
"marketing_segment_id": "ac4bac85-2863-4da7-bc4a-c00241fbfaef",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6565f30b-3820-4a12-8246-6006cd70eb68",
"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": "0db18f1c-8b01-4dc0-b1d0-780227b6cdf9",
"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": "9a509d7f-6f4b-4a6a-840b-cc432eccc862",
"db_country_code": "sample string 28",
"feelist_id": "f88fb3d4-a5a6-43dd-b29e-e6612660319c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ba98d84f-2dbd-4f1a-be22-2e01189304ce",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6dd978e0-5b3b-4db0-9337-207274712ba9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-06T00:21:52.6271799+00:00",
"db_currency_id": "e7194122-c43e-4403-a5df-dc78c12c7c92",
"db_currency_code": "sample string 10"
},
"company_type_id": "598b02d9-2e31-410c-95d7-fd431866189a",
"company_type_name": "sample string 32",
"company_type": {
"id": "65fd8593-3354-4267-bf6f-28157dfa3de3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a3ea23f4-9c75-4cab-8330-01fe0ff6e884",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9e4095ee-0fe3-464a-9acb-7d31d1f46662",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5f0897a4-d205-4388-a27a-f3da87be7298",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "004684ad-da75-483c-a2f6-09313fb4d438",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ddea952c-5b9b-493d-98f4-2b80fcc6183d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-06T00:21:52.6271799+00:00"
},
"company_sector_id": "317197c8-240c-4140-abd6-85af6ef95ac9",
"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": "fb3135cc-ae52-483c-840c-832f595c4877",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "29c54ca7-fd71-4ed5-96d5-2ae4d4559dd2",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "30b5e685-3011-4763-8a7b-c3f1ea6dbdcf",
"account_manager_user_code": "sample string 56",
"company_status_id": "d6d03921-2553-4d69-a340-d1bdbbf0cd64",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-06T00:21:52.6271799+00:00",
"id2": 60
},
"db_language_id": "8754cf28-4ed1-4305-89cb-e154435af50f",
"db_language_code": "sample string 7",
"db_title_id": "6f0012da-b4ef-493e-952e-42de606e8bc5",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-06T00:21:52.6271799+00:00",
"create_date": "2025-11-06T00:21:52.6271799+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-11-06T00:21:52.6428354+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.