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": "8faa391b-501c-48a7-96b1-02205a364ca3",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "92fa7d0a-fc36-4e94-aad3-02dadb7eac2f",
"company_code": "sample string 5",
"company": {
"id": "c4ccd496-f354-4f20-94a3-4e00f02859a3",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-21T11:38:27.4584714+00:00",
"sales_territory_id": "5573fed0-88af-42a3-999f-d3a3c8eb3ffd",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "bb51211e-059d-41f4-bd7d-96bba2053cfb",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c20e437d-9377-4b8a-a872-25a35753a828",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ae1f37a0-7470-4993-8c3c-baa2ff274c8f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "18273801-af44-4b89-aa22-1ca9b49ee1c5",
"db_currency_id": "769aae20-cac4-4689-ba09-8baac7b78e38",
"db_language_id": "d22dee01-317d-401d-8ceb-154b6b32d0d1",
"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-09-21T11:38:27.4584714+00:00"
},
"modified_dateutc": "2026-09-21T11:38:27.4584714+00:00"
},
"marketing_segment_id": "650077ca-1b56-48b3-8755-b54701fddb58",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "9c38471f-bc5e-45b6-8f28-439412555811",
"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": "e3020a51-0c6e-49cc-8ad9-77dc8794779f",
"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": "0600fdf7-4681-4171-9876-f121ecf93883",
"db_country_code": "sample string 28",
"feelist_id": "8f3df529-8991-4ffb-a790-fcb64a11c225",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ea747c8c-0b87-472d-913b-77e7469ad566",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "30460e92-bf74-4fea-9cf9-cb546fc43c90",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-21T11:38:27.4584714+00:00",
"db_currency_id": "86ca770e-55fa-48f2-9b03-e654db81a578",
"db_currency_code": "sample string 10"
},
"company_type_id": "620d4a10-efbb-4f02-a0fb-07f53eb3cf9b",
"company_type_name": "sample string 32",
"company_type": {
"id": "171fe32f-7d86-46b4-bbf6-b35152b45443",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "98521fe3-14da-40cf-a572-328daf9861a7",
"sales_organization_code": "sample string 5"
},
"db_language_id": "89d4ca86-be2c-4e6f-9049-705d8be8efaf",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "100750dd-670d-47fe-ada6-6df458ed7c2c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "795a7864-e541-4a43-af0d-039b7b078110",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9ac6e21c-6301-4d60-87a7-98e59ac54988",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-21T11:38:27.4584714+00:00"
},
"company_sector_id": "17142965-c323-491e-b86a-659712b1dec5",
"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": "83a53ce3-f9ab-423a-8dc1-84f0c2455d53",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a3341b27-ba02-49f3-a458-080f2688d767",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "511eae8c-412e-4308-9a3e-a94cbda5997e",
"account_manager_user_code": "sample string 56",
"company_status_id": "5fe7e3fc-0998-4d4b-b5c7-020bb90d2bb7",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-21T11:38:27.4584714+00:00",
"id2": 60
},
"db_language_id": "81f8e6fc-5039-4525-b4f6-34d60eac98ed",
"db_language_code": "sample string 7",
"db_title_id": "ecb2588b-7f37-42ad-935b-7fb769c27c5f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-21T11:38:27.4584714+00:00",
"create_date": "2026-09-21T11:38:27.4584714+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-09-21T11:38:27.4584714+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.