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": "e0081cf3-8b10-4b8b-b94c-81147ac29997",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "04e5dce2-6697-4ab8-af06-ba0b8e817843",
"company_code": "sample string 5",
"company": {
"id": "84902253-c0a1-4f1b-957e-3ad2a2c88058",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-08T11:09:17.1130941+00:00",
"sales_territory_id": "68ffc8ca-bfa7-47a8-974f-bc12114493c9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "183fc22f-50bf-4289-a9fa-c792e0ca28b3",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bd7a2631-9268-4edd-9b51-5898488972ad",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "928a6f77-e95b-47c3-a4db-4479833df068",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e31d8fd2-56c8-45c4-9453-dc410e5466fd",
"db_currency_id": "0bab04e8-e15e-41a3-9f61-84e8b9dd6508",
"db_language_id": "a2aeff9c-511b-404c-b694-d896483df6e3",
"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": "2025-12-08T11:09:17.1130941+00:00"
},
"modified_dateutc": "2025-12-08T11:09:17.1130941+00:00"
},
"marketing_segment_id": "b4949fd3-b750-4519-84c5-2a237c5edbe9",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0edad046-8d2d-4d62-9825-9180023b9d73",
"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": "32667345-ab3f-4bb1-8d86-9caa4690fa85",
"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": "be61901c-c0b6-445c-b037-fe32399a74cf",
"db_country_code": "sample string 28",
"feelist_id": "aa60e586-f909-4c75-bfff-a522782c11db",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "bee564a6-64af-48a6-9017-d29d70c1ad40",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c1f0332a-5bb2-4c19-81e1-68f960e8416f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-08T11:09:17.1130941+00:00",
"db_currency_id": "77b888f1-cf98-4444-9579-d3761db78537",
"db_currency_code": "sample string 10"
},
"company_type_id": "129a1bfb-21eb-43c5-9d88-fdd0ec5fc5d8",
"company_type_name": "sample string 32",
"company_type": {
"id": "994f149b-f4fe-4cf7-9f69-50aff8c17d88",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f9674b67-1bc2-4bf8-add9-f85cd9a92435",
"sales_organization_code": "sample string 5"
},
"db_language_id": "598a5ecb-e367-48a1-a8f2-4a5d42571fb4",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "b6ee9207-c2a9-411a-a535-94a40ee4d83c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "9b22a973-dd91-48fd-94d0-3b314db4d21e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "eea5fd14-f393-4b83-b74a-7a91190d8bde",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-08T11:09:17.1130941+00:00"
},
"company_sector_id": "af0af9f3-52c2-409e-ba16-4b235ef33851",
"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": "1078d1a0-16bd-4953-b402-a3e853262883",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "665b2d47-9363-44ec-8929-bf1b5a8e7aea",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0f8d2b63-d830-4429-b5de-46989cbc2c39",
"account_manager_user_code": "sample string 56",
"company_status_id": "52f926e1-e1b1-483a-99f7-e986b70917cc",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-08T11:09:17.1130941+00:00",
"id2": 60
},
"db_language_id": "6fe9f5b5-7e1b-4a43-a235-8f39040561e5",
"db_language_code": "sample string 7",
"db_title_id": "235f896a-a61f-4e9c-bc12-ae6a10905b9a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-08T11:09:17.1130941+00:00",
"create_date": "2025-12-08T11:09:17.1130941+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": "2025-12-08T11:09:17.1130941+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.