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": "c95383c8-1eac-4e0d-9005-1df034222937",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "60f64350-8042-4d84-9668-09d7c4f7572c",
"company_code": "sample string 5",
"company": {
"id": "947bd558-6653-48c8-9933-d5d3c62663d2",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-05T21:24:10.8224871+00:00",
"sales_territory_id": "b0544d14-bd93-475d-b9cd-b449cb621942",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "4cb3b5bc-5f56-4aac-99ef-bd2b8911f6a1",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9a645843-2204-4b6b-90e4-12048efc8d9c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "663aae41-08c7-4d9f-879f-07a6b1c645fb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4fb6af37-bb2e-41a2-991d-3e8644b72ab0",
"db_currency_id": "5f1af400-7d90-4528-9979-4df6174cd671",
"db_language_id": "c5ec18e0-dfd1-43ed-8f7b-50c706161961",
"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-06-05T21:24:10.8224871+00:00"
},
"modified_dateutc": "2026-06-05T21:24:10.8224871+00:00"
},
"marketing_segment_id": "d0398096-8bbc-4a2c-822c-d004953b254b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7bbc68c9-f9b0-4d4e-a143-65172ec5e78f",
"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": "bc7d04d3-48cc-4192-8d54-6dd95ccb497b",
"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": "8cdd75fc-8863-4663-aec1-8fd8d2528e64",
"db_country_code": "sample string 28",
"feelist_id": "1c3d5adf-5c11-44f1-85f3-70072dd683a2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c69eb6dd-9f2d-4d9b-b933-3236af87bdf3",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "917185df-ed87-4f42-8683-4e23bad3f830",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-05T21:24:10.8224871+00:00",
"db_currency_id": "77f35b61-42d8-4566-8dcf-dabe27d71f44",
"db_currency_code": "sample string 10"
},
"company_type_id": "b22abdfc-6702-4c72-abff-6db8cb00e6d6",
"company_type_name": "sample string 32",
"company_type": {
"id": "b8c59380-965b-4393-b499-8588095785b9",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d7eb271c-9c51-42dc-ab39-e0d7b7c0c3ab",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a866705e-6c2d-4e00-ab63-259553c19192",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "642babde-c122-447a-bfc4-c6a472c05f2b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8b35be84-3f6c-4a87-97c8-16aab73ded99",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "459cc642-1e10-46e7-80d8-ed5a062fd760",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-05T21:24:10.8224871+00:00"
},
"company_sector_id": "7a5d8c1f-a846-4714-ab6b-7441381fe2ea",
"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": "fca02bba-f458-42ac-ad95-fb3ef758b73e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5d33d533-b8c7-4bc1-a129-d91782ef1753",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d572cf5f-93ed-43e6-8eed-1a9510f42fe0",
"account_manager_user_code": "sample string 56",
"company_status_id": "6f2656fe-2a7c-48d6-bf55-b6e77aa9c036",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-05T21:24:10.8224871+00:00",
"id2": 60
},
"db_language_id": "87949b9e-a6be-4d19-825b-09b5c3be0c63",
"db_language_code": "sample string 7",
"db_title_id": "b97c3465-6aa7-49ad-8152-85bbb078e602",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-05T21:24:10.8224871+00:00",
"create_date": "2026-06-05T21:24:10.8224871+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-06-05T21:24:10.8224871+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.