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": "ff0b8baa-bbfd-40dd-be68-21601541dc5d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "571085d6-066b-4b0f-aa64-8279827599f5",
"company_code": "sample string 5",
"company": {
"id": "76f2a10f-aae9-4b73-9b00-dc792b7a4a05",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-02T03:48:35.9125422+00:00",
"sales_territory_id": "d62922e4-f778-4108-9a39-005fa6abb65f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "54a78c03-5281-4a39-a1c9-e5fc5512a5f4",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "124482db-80ed-4bab-b89e-1a0e7eb3e8c1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c2167f2a-06c7-4534-ace4-e6a0673247c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e1b3ff5f-64a5-451e-8f35-3cf6a3d81db9",
"db_currency_id": "e32007f3-3f25-4060-bcc1-614b9f4b1669",
"db_language_id": "e1241a95-e3ea-4d3c-a3f8-35e0e60b529c",
"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-06-02T03:48:35.9125422+00:00"
},
"modified_dateutc": "2026-06-02T03:48:35.9125422+00:00"
},
"marketing_segment_id": "5cc8538e-a2b0-46cc-ba0e-979e8bcec9dc",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "aeb8fd91-196e-43cf-b863-6099b0ca9aa3",
"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": "434befbd-1612-42c6-886b-6fd81a5d3cd0",
"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": "c67edacd-dc7a-44bf-bbe5-d5ee22c3e638",
"db_country_code": "sample string 28",
"feelist_id": "507c810b-ee0c-4dcc-8419-d1b28c2c589a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "0cd93f6f-e4d9-4058-8e6b-0affa534d142",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8a8f7f30-0897-429b-a516-848c3d60328e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-02T03:48:35.9125422+00:00",
"db_currency_id": "4a214796-1061-4dff-8436-013e233a083c",
"db_currency_code": "sample string 10"
},
"company_type_id": "7c185405-0c4c-473c-817a-acb7a8500a4a",
"company_type_name": "sample string 32",
"company_type": {
"id": "931e660f-f094-42a6-a5cb-8b5f73bcb490",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "30519d12-bd6f-4297-a2d0-26adc53b4981",
"sales_organization_code": "sample string 5"
},
"db_language_id": "97c4537d-b495-4a89-96b2-93e4482b2714",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "abe3f8bc-daa4-4158-bd79-374a1bd5d192",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b139ed11-cd3d-48a5-aeb5-e68a3326dcc7",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c0017016-3126-4cd1-8a4f-bf61f49af038",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-02T03:48:35.9125422+00:00"
},
"company_sector_id": "ab730a85-b0cf-45be-8706-3e116b3b55aa",
"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": "7b646553-993a-4751-bdd3-b165199dd5ca",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "fdfc26a4-572c-41ff-a6b7-4cc74e9c2991",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f5215f8d-14c6-4f81-9abe-4daa5ed8be76",
"account_manager_user_code": "sample string 56",
"company_status_id": "de46d79f-0738-44e4-a998-089965d67fc4",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-02T03:48:35.9125422+00:00",
"id2": 60
},
"db_language_id": "6e5e67c2-fc85-4d37-9ad0-f2ada5fee1ac",
"db_language_code": "sample string 7",
"db_title_id": "10a637dc-0e71-4ace-aef1-57c8aceb330c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-02T03:48:35.9125422+00:00",
"create_date": "2026-06-02T03:48:35.9125422+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-06-02T03:48:35.9125422+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.