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": "263539b2-9327-473b-aec9-4b7fb64c0829",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "43f97344-78f5-4179-923e-57b1fe4fa9f6",
"company_code": "sample string 5",
"company": {
"id": "3888eec6-35c4-4825-8b54-c319f02091f4",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-17T09:00:37.8079993+00:00",
"sales_territory_id": "243b62cf-4ad6-4ce4-9ead-82d207d96814",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e541cdc4-e720-4b66-8e0a-9663fc1be934",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9c830c61-258c-4cd2-9d4c-11d71802a3bc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c1fa82a4-8047-4892-adf5-f2ccf448ed9a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "00f40ae4-5c9b-42cd-b380-986870033f1b",
"db_currency_id": "79d4750d-fe3b-4955-a057-e6e84c199cb4",
"db_language_id": "38f16bf9-0c57-4605-b552-b932a8e95b6b",
"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-17T09:00:37.8079993+00:00"
},
"modified_dateutc": "2026-01-17T09:00:37.8079993+00:00"
},
"marketing_segment_id": "0f91fa0a-d9c2-4758-ab53-a9ddc1b65834",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "09c8b6f6-f603-42c9-8938-c0ba16b1a4ea",
"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": "ff83e8d9-6ae6-417e-88c7-b3aa008973e8",
"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": "06e60b86-f196-4e31-9540-3705302a67a6",
"db_country_code": "sample string 28",
"feelist_id": "9b2bbf79-918a-42c6-a37e-439a04cbe339",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "58c288a1-a8fd-4a2e-ac6b-33c0abba8373",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "16f849c2-388d-4040-bf96-7f352ff2a034",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-17T09:00:37.8079993+00:00",
"db_currency_id": "fc2a8a31-e68f-448e-8578-ce0742175644",
"db_currency_code": "sample string 10"
},
"company_type_id": "533579f3-55c1-4fe9-9114-e6504b90593c",
"company_type_name": "sample string 32",
"company_type": {
"id": "4e57ca3e-8601-4bb2-b0e2-f6e3d4e86a48",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "67c5900b-fc9d-417b-82f3-860fcd096f74",
"sales_organization_code": "sample string 5"
},
"db_language_id": "302c945e-e393-4f1e-a976-708a804816ac",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "b11635cd-edc4-48e5-adb2-fe65ee202e98",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "55d3ec9d-3fa1-452a-9f2c-e1f2c367908e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "84d32cb0-e5ce-455d-a1a5-bbbab7111892",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-17T09:00:37.8079993+00:00"
},
"company_sector_id": "a03f1887-0054-4a3f-b2d7-392ae5044be1",
"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": "c06f648d-5fd5-4228-a6f9-468014413cce",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7fd88c32-fb5d-45ef-80c3-ad98db549dfa",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f38359d9-4365-4e60-8103-01832aa743a0",
"account_manager_user_code": "sample string 56",
"company_status_id": "14b57cbc-f660-44d9-8f49-c1555e90fe5f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-17T09:00:37.8079993+00:00",
"id2": 60
},
"db_language_id": "62d4bd21-ed98-445b-87f0-23eda0065f24",
"db_language_code": "sample string 7",
"db_title_id": "2c21e350-bd5d-4b55-8a0d-7bb9175f084b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-17T09:00:37.8079993+00:00",
"create_date": "2026-01-17T09:00:37.8079993+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-17T09:00:37.8079993+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.