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": "80aea819-ced1-4d79-95fc-f28e8115a3be",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a037606c-c4d6-4cf4-94d5-835a0bf651ef",
"company_code": "sample string 5",
"company": {
"id": "33d03ae7-e769-45bc-87bb-268b609bfee1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-26T00:59:54.139177+00:00",
"sales_territory_id": "bb02994f-42d6-43e9-9b24-837b44101c2b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ce54de37-695c-47f1-9fbc-b79482690fe8",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "85ab4a98-7a2e-45fc-9330-3fc8c84c5c37",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "60c98565-8101-4839-8d9c-47c061aefb99",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b75875d1-e935-434c-ba52-d30c1328a9c2",
"db_currency_id": "63c27845-0895-4b15-96a0-6893d611dcfa",
"db_language_id": "7f66888a-d76a-4af2-8917-e22ab44c0e9a",
"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-26T00:59:54.139177+00:00"
},
"modified_dateutc": "2026-06-26T00:59:54.139177+00:00"
},
"marketing_segment_id": "45019e4b-5847-4287-ac9c-a4e779fc859d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0e2dd252-703a-4932-aa1a-0292a43ce01c",
"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": "29591c6c-78e3-442b-8307-dabc49fb7151",
"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": "97cbafb1-01b6-4916-a3f0-f718cba04c3d",
"db_country_code": "sample string 28",
"feelist_id": "e3a80d58-89d4-4b01-ad83-c5cce805aa2b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c281e435-9034-4019-b02c-7a9a68e23ca4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b2c97e91-30d9-4319-8e32-bc75f356fc77",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-26T00:59:54.139177+00:00",
"db_currency_id": "5e453c96-29c2-4a6f-9f7d-f05f34dd8a53",
"db_currency_code": "sample string 10"
},
"company_type_id": "e3aab6ad-0ba8-4ff2-a498-40feb00e70b8",
"company_type_name": "sample string 32",
"company_type": {
"id": "0ca6b164-b29e-4006-983f-70b542603fd2",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b0760516-c878-43ef-87e7-f688f2f9c8da",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9ec431de-09b0-44c7-958f-42dc3c1feadb",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "b06e2ed2-a57d-4f57-b6a3-39b21a231cd1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "25144bfa-1d23-4389-9c92-70ee495e05a5",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "86af4be3-dd9e-4a35-a3b8-9c40686e39ec",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-26T00:59:54.139177+00:00"
},
"company_sector_id": "aee46bab-ae50-4898-83dc-6e8d298e6b70",
"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": "0b211273-7427-46bf-94ca-329e7255c958",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8e9076d4-b2db-4fa0-a795-1de66bff9064",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0432202f-c607-4cef-8af1-802e5d0f234b",
"account_manager_user_code": "sample string 56",
"company_status_id": "83abeab5-f937-4a37-8e54-0b09e81cf8ea",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-26T00:59:54.1548018+00:00",
"id2": 60
},
"db_language_id": "14ea44af-1874-4830-81b5-e316e30ac9db",
"db_language_code": "sample string 7",
"db_title_id": "1700d765-7f9a-4281-827b-4f9961c5ba47",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-26T00:59:54.1548018+00:00",
"create_date": "2026-06-26T00:59:54.1548018+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-26T00:59:54.1548018+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.