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": "664a6ece-0d15-4d0b-9e28-1cd9728be3ca",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e1b3b8af-c0ab-45ac-952a-cd58dba7d5a0",
"company_code": "sample string 5",
"company": {
"id": "271482c8-76ff-415c-aa41-08ed5857f8f0",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-19T14:44:47.5864111+00:00",
"sales_territory_id": "ad93ffc8-0e58-476d-b8d8-2dcab722e5ea",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b3294d3e-00b1-4054-8a83-5ae8cd61cf7e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "678bac1c-072d-4c5e-a72b-915f24412121",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "92d9e405-0692-471c-9043-04e2fe0a4da2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a71b8876-1d3e-4d4d-aa31-812dff4f9d40",
"db_currency_id": "2c71be45-7f3a-474e-bed7-12b9d6a9842f",
"db_language_id": "835d8ba7-c326-4e0c-8ad4-a0934782c4ee",
"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-01-19T14:44:47.5864111+00:00"
},
"modified_dateutc": "2026-01-19T14:44:47.5864111+00:00"
},
"marketing_segment_id": "94ddfce2-ce8e-4b26-bac1-3ee0103eda42",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "9d2c382d-bbc7-49ae-9a37-217d2359d65a",
"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": "6d8ffe41-9964-482e-a1b3-74cc19364735",
"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": "174143ee-827c-4a55-a69a-2a05a76906df",
"db_country_code": "sample string 28",
"feelist_id": "82a4ecf0-23e5-4067-a641-587ce25c4e67",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6fa31340-8719-43f9-b362-80ba490551b0",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2f8450d8-d784-41cc-af2c-515f13b8e17c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-19T14:44:47.5864111+00:00",
"db_currency_id": "55777781-06de-4137-b49a-4f08d157f703",
"db_currency_code": "sample string 10"
},
"company_type_id": "04e19ae2-2ef4-4de4-84b4-2c2c16c51df8",
"company_type_name": "sample string 32",
"company_type": {
"id": "9917684f-508d-4662-9672-1de88425f62e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6198d1d8-bc5a-4940-93de-038d62506620",
"sales_organization_code": "sample string 5"
},
"db_language_id": "fd4aed0d-813e-4d63-8fd7-c24c015ccad5",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "412ae275-54fd-4389-8029-d4ea800907d1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d2995dfd-ccb2-4a4c-b3df-1adba5dbf3d6",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3e42776c-998d-4b75-9bec-c1524b2f9e15",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-19T14:44:47.5864111+00:00"
},
"company_sector_id": "7262b26c-774a-499d-b3e5-9ab07b0dee87",
"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": "1ede038a-87dd-423b-9d86-ac204c34b0cc",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e9e46723-e8ef-4621-a938-286e579aaca0",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "35c102c6-71d2-4619-8982-013af38557f5",
"account_manager_user_code": "sample string 56",
"company_status_id": "369ec6c4-5bee-475b-99e1-3edf9df9800f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-19T14:44:47.5864111+00:00",
"id2": 60
},
"db_language_id": "cfb3c573-7b58-49ba-ae0e-cb6f1fe8fe5a",
"db_language_code": "sample string 7",
"db_title_id": "7f4539e7-acaa-425a-8814-fbb26e80e333",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-19T14:44:47.5864111+00:00",
"create_date": "2026-01-19T14:44:47.5864111+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-01-19T14:44:47.5864111+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.