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": "af67170f-2e59-40d4-8701-e7cdbdd41387",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "21b490c0-0814-4e18-9bde-18c3eb6e87f1",
"company_code": "sample string 5",
"company": {
"id": "1a56dcef-6131-4e8b-b97d-67fa9919d899",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-09T22:48:06.7418939+00:00",
"sales_territory_id": "d563a3c6-ad16-4b1d-b654-eedf305b6630",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "695c3387-2fa7-45cc-8849-d1d5dcb11f9e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "08a6f9c1-5a5b-4571-952e-7942a60f71dd",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c7530e0c-dc6c-4d66-aca3-5bd64d9059e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9855da82-d456-49c3-84d3-2c347845d321",
"db_currency_id": "88c023cd-02b1-4f2b-a090-2ccd514760a6",
"db_language_id": "660b1e96-2da2-4f59-accf-bbbbadbccad2",
"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-03-09T22:48:06.7418939+00:00"
},
"modified_dateutc": "2026-03-09T22:48:06.7418939+00:00"
},
"marketing_segment_id": "2cb90c26-826b-441a-a124-0919bdf5e3e5",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4aac8056-0f6c-47f0-ac8c-d063865d59b3",
"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": "e7e8ef91-a753-4368-84e2-31d2dd903c49",
"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": "f688831c-475d-4ccb-8b95-470c02c180fd",
"db_country_code": "sample string 28",
"feelist_id": "a79cb601-260a-46e5-a68c-e113c7682cdd",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "9c6fbafc-b27f-447a-a1eb-7c4e687a6bbb",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "77ae48e3-01d4-4e29-8bbd-de64fcc4587a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-09T22:48:06.7418939+00:00",
"db_currency_id": "6f9e8d47-6d2c-4f4f-bf49-a666a92079a6",
"db_currency_code": "sample string 10"
},
"company_type_id": "b4734833-adaf-4520-b1b1-97e81f4ce95f",
"company_type_name": "sample string 32",
"company_type": {
"id": "c2baac6b-e535-4ecb-b21c-83f930261df2",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "da9dbab2-c1ff-40df-b137-a967ac3f3b52",
"sales_organization_code": "sample string 5"
},
"db_language_id": "4455c6eb-dafe-47fd-aa11-20f588d93619",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "19f40f21-c92e-493f-8bfc-74961dd6fc94",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "efbbaf9b-cf7b-4fa2-b549-11b3cb3963ae",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a5029010-f3be-4ef1-bf98-d03c7173f62e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-09T22:48:06.7418939+00:00"
},
"company_sector_id": "3cd2a76d-00ca-4a33-8052-2aaeecaef9fe",
"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": "bad804cf-8ec8-4854-8cbc-41f4bb6e379b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "92857e43-9f72-48cb-a7f6-bfb7b1e32718",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ba9c2f7b-d047-4106-86b3-fe1ff63a1f5f",
"account_manager_user_code": "sample string 56",
"company_status_id": "ff2e0683-0bc5-4ea1-bcdf-1a7524343a0e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-09T22:48:06.7418939+00:00",
"id2": 60
},
"db_language_id": "add2efb5-b3ba-40ab-b3e9-4943b4c91d61",
"db_language_code": "sample string 7",
"db_title_id": "056baf22-7abf-4877-a344-ed1c4032581f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-09T22:48:06.7418939+00:00",
"create_date": "2026-03-09T22:48:06.7418939+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-03-09T22:48:06.7418939+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.