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": "85f718c6-c069-4d27-952b-2da06a5e26ed",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "bdca858f-5bef-4212-9341-98ab0ff0c286",
"company_code": "sample string 5",
"company": {
"id": "dbcb3532-8b64-4190-b9aa-86f7bbd81dda",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-21T21:33:52.818372+00:00",
"sales_territory_id": "08f1e51a-3c4e-4eb2-af26-d542c140c4c4",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "958c7c2f-2956-4891-9802-f632e695ecdc",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d4d6f893-8314-443e-a09b-a524194b444c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b8c9c7c4-1a87-4420-b26e-7742c2f87bbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "47ed4a0d-1cc0-4477-aa32-90ba0db8071b",
"db_currency_id": "2de24d08-c8fd-4199-9336-3a915e761439",
"db_language_id": "85d978ef-571f-443f-95fa-54d5673e967b",
"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-21T21:33:52.818372+00:00"
},
"modified_dateutc": "2026-09-21T21:33:52.818372+00:00"
},
"marketing_segment_id": "efb2115b-be13-4d34-b8f7-de843802c66b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "16137dd3-c458-480f-a6d7-541db1f08e7b",
"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": "b0aeb770-8063-468a-b96a-fb580f26a4c0",
"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": "54f40ee1-43e7-421d-ac1b-179169148a75",
"db_country_code": "sample string 28",
"feelist_id": "7a217725-a970-485c-a1ae-04f4180951ca",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "22d3cb41-e4d8-4cc0-a58c-825a13f315ff",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b8fa9b8d-f2b3-4fe8-96fa-b6cd27bdf854",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-21T21:33:52.818372+00:00",
"db_currency_id": "01e0c417-f7ef-4435-91c3-4e055e5565a1",
"db_currency_code": "sample string 10"
},
"company_type_id": "0bc58cee-989e-4fa8-a221-d0b369802cfd",
"company_type_name": "sample string 32",
"company_type": {
"id": "7c9c3fe4-fc22-4889-bf0f-f77512e0b071",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6a0c4dfe-ccee-4a58-93d8-6bdb6bc69a14",
"sales_organization_code": "sample string 5"
},
"db_language_id": "54b2cdf5-a99a-43a1-86c5-aa723323aea0",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c6decaeb-f8db-4a7f-a1b6-b867a5d46fd7",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a833869f-2868-45bb-8009-af64d9e4e49a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "910bbdc3-8549-47ad-b829-251eb43c8e4b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-21T21:33:52.818372+00:00"
},
"company_sector_id": "76064b5e-d437-47f4-beaa-a1e366f3e04d",
"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": "431d815d-ace4-4615-be50-640dc08c8559",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d0735252-445f-439d-bfcd-cabc14fa44bc",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ae2c3a39-5108-46a7-9b0e-ef71fdf3cb41",
"account_manager_user_code": "sample string 56",
"company_status_id": "6952bd3d-d546-4dd4-93de-6619211881d4",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-21T21:33:52.818372+00:00",
"id2": 60
},
"db_language_id": "f2c93428-1c40-40bd-9e64-d8820d15c420",
"db_language_code": "sample string 7",
"db_title_id": "d174bce6-7d05-4aad-b395-fb419d4924c9",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-21T21:33:52.818372+00:00",
"create_date": "2026-09-21T21:33:52.818372+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-21T21:33:52.818372+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.