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": "f1e718ab-dc88-456f-a09b-0712ed3db6e2",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "58fb4908-7bd7-416c-b20d-b9352691c22c",
"company_code": "sample string 5",
"company": {
"id": "9f08a600-6e12-4590-a9ac-2256eaa58cab",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-17T13:02:18.4631344+00:00",
"sales_territory_id": "4d9248dc-0a19-42d5-9736-7c0ac2428d5f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d0c40b84-3200-48a7-ac5c-97fde2b41ac5",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9888532d-242e-4cdb-bc98-e022338ffeef",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d68110f6-0245-4e41-bd51-5b23bb3af4f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9e506d96-6580-44f8-9220-f765bee2f889",
"db_currency_id": "1818f69f-951a-496e-8fcb-6827ed2de49f",
"db_language_id": "f6fa102a-d41d-4886-984f-d9d4da580771",
"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-17T13:02:18.4631344+00:00"
},
"modified_dateutc": "2026-09-17T13:02:18.4631344+00:00"
},
"marketing_segment_id": "bf683425-99ab-46d0-9805-34a7aa8ba837",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "32926b8f-2448-495c-8ed0-a7ed63cc373b",
"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": "2277e493-735d-425f-8fd7-07c4e5f11ba3",
"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": "8cb0f083-8e95-42de-867e-74207805da69",
"db_country_code": "sample string 28",
"feelist_id": "4363629c-f9cd-4d09-a252-1b65c0735b02",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ed3df485-1e04-4adb-abdd-5e3b338357ff",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "12856451-8c9d-401a-9d72-7f8df96640bb",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-17T13:02:18.4631344+00:00",
"db_currency_id": "2a12db84-a411-42c0-a898-6740309ca48a",
"db_currency_code": "sample string 10"
},
"company_type_id": "eae74f53-5cdd-47de-9cd1-530404446037",
"company_type_name": "sample string 32",
"company_type": {
"id": "6ff9abd3-da85-4c27-bbad-cc0dba806571",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e24ca3e9-7aaf-4fb6-a432-01fbd0170ce6",
"sales_organization_code": "sample string 5"
},
"db_language_id": "505748d4-9525-4f42-9122-8ee0496756eb",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "11017e21-72a5-487a-aeae-db28eb1cfc88",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b40954af-8915-4236-a999-0de09e48dd8b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "dfad9d17-17fc-4801-b3b0-11f8cac29563",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-17T13:02:18.4631344+00:00"
},
"company_sector_id": "ad2ae4c7-c01c-4474-9147-d180d7f8b07f",
"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": "3cc27a43-dc04-4ae1-8922-44d941a2c0b0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5ccaba33-de99-449a-8ae7-c1fcac7cb592",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "cd7b14bf-e6fd-4ccc-aa32-119c61088215",
"account_manager_user_code": "sample string 56",
"company_status_id": "d0b0d578-18f0-45c8-af6b-82cc7c6ba85f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-17T13:02:18.4631344+00:00",
"id2": 60
},
"db_language_id": "77c5167d-7942-4275-a6d5-233449bda280",
"db_language_code": "sample string 7",
"db_title_id": "33205073-5bf9-450e-b65f-b1ed22539fde",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-17T13:02:18.4631344+00:00",
"create_date": "2026-09-17T13:02:18.4631344+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-17T13:02:18.4631344+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.