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": "48c07751-5cb2-45f7-8b81-ac97ba2facb2",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "661032fa-b27a-48a8-8781-571f03796c86",
"company_code": "sample string 5",
"company": {
"id": "d3510d20-f631-4de6-8e1e-0a7d30e99b68",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-28T12:48:54.080314+00:00",
"sales_territory_id": "7a4bb14b-7477-4b1b-8495-32e7e509f053",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9ac4ee2f-875e-4850-94d2-36243480f184",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b2f665cf-d8c2-4961-b609-8f3d5b9f0f1e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "74947270-089b-4306-ab19-22fa963f9d6b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9b045465-e423-47c5-9d7e-c18de45ce6ff",
"db_currency_id": "36018bcb-8488-4fbb-9d67-a82559061ec3",
"db_language_id": "4615308c-0c0a-46a0-85a8-0e9231237d35",
"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-05-28T12:48:54.080314+00:00"
},
"modified_dateutc": "2026-05-28T12:48:54.080314+00:00"
},
"marketing_segment_id": "aca99cf4-f830-4ca4-b1b6-b3936f2391ca",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "76b3a606-4377-432b-9ba8-469cc450f1d0",
"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": "7ca94a14-1a45-4480-a1b1-3b0c203c51ca",
"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": "42a2ae01-be39-47f7-8279-93d4f6ea0831",
"db_country_code": "sample string 28",
"feelist_id": "7a35ba60-08c8-4593-9d6b-3bb021e129f8",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "0fcbe03e-64f2-4edc-b72a-099419bc33b2",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8cd84fd9-063b-484c-a8c2-03e7bd805338",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-28T12:48:54.080314+00:00",
"db_currency_id": "4bd3897e-ea14-43db-95dc-20b365dfde9c",
"db_currency_code": "sample string 10"
},
"company_type_id": "633b5438-8489-4457-b576-40f4c50b7ec3",
"company_type_name": "sample string 32",
"company_type": {
"id": "59a6ceb8-497e-4529-9080-8dce1b0aea94",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b397564e-4382-43f9-a648-03bbf5a77ea2",
"sales_organization_code": "sample string 5"
},
"db_language_id": "df8e8c9c-6067-4637-ab55-ddb6e91af169",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "05a8dcc8-cc90-4014-897e-2b37e175bbab",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "89b3a2b7-bbfa-41b6-abe6-b4e6671366a4",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4ad2516f-bd3b-4b25-9bab-277e311ede41",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-28T12:48:54.080314+00:00"
},
"company_sector_id": "f461247b-a61d-4dfd-880a-f225dffaeb93",
"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": "3d69d7dc-4f89-4b54-bdea-1ceb475a97a5",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2b4e2a27-0553-44ea-a64c-c1dd53f420f1",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "49ab62dd-c119-4e6e-b1b9-e73fae58fba4",
"account_manager_user_code": "sample string 56",
"company_status_id": "8882e322-41ba-48c9-af8f-bc96d5329e10",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-28T12:48:54.080314+00:00",
"id2": 60
},
"db_language_id": "2ae2b33d-a436-4cbd-98ab-f4737529ff9d",
"db_language_code": "sample string 7",
"db_title_id": "9f05e1de-fc7c-4c9d-8646-66ebf7ff4acf",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-28T12:48:54.080314+00:00",
"create_date": "2026-05-28T12:48:54.080314+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-05-28T12:48:54.080314+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.