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": "d0e0a687-c7bf-4e92-89ef-1d424b3e1098",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c0238892-38af-40f4-88e3-54184c76af5f",
"company_code": "sample string 5",
"company": {
"id": "f747a281-4e70-4b75-8ab0-5973dd4686e8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-14T04:29:01.3297627+00:00",
"sales_territory_id": "e83f3cc4-f4be-440a-947e-c2adf7cd0005",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e9ec31e2-0c10-425b-b355-b22e604371fc",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cec8710b-8686-40c6-ba85-32ae4a27c478",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6c51d205-ced4-45d3-9c66-ac70223b943e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81049624-9d65-41ae-bef6-0b060e3baa4f",
"db_currency_id": "0aa2833d-1e59-4ac4-97d9-52efe373fcc3",
"db_language_id": "97252f70-ced7-47c7-88bf-d0b42289c1e4",
"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-08-14T04:29:01.3297627+00:00"
},
"modified_dateutc": "2026-08-14T04:29:01.3297627+00:00"
},
"marketing_segment_id": "7d7c7691-09ae-4a42-9bb8-7bc58ecf5237",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d61ecb1b-2e7f-4c0f-a5cd-7793027661dc",
"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": "a26fdd2f-bf37-4c04-96b4-800ddc948990",
"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": "d3aa8ba8-05d7-4f1e-835c-7d0446751dc6",
"db_country_code": "sample string 28",
"feelist_id": "5097ad59-8f09-4482-bc7a-430a8e388014",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "9ba49289-5dfc-42e3-8e25-de8d5e872c9a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e476cc56-1404-4ab0-8455-eb5e4c7b712b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-14T04:29:01.3297627+00:00",
"db_currency_id": "689733ed-b10c-4dd2-b764-dcc6d6037d41",
"db_currency_code": "sample string 10"
},
"company_type_id": "cd0d02fc-8afd-427c-a007-758d5577e1ba",
"company_type_name": "sample string 32",
"company_type": {
"id": "2917666c-8b71-4e8d-843c-48910b95f4d6",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "32e02eed-dda4-4307-a8de-143bcdefdf89",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c31c2ded-6430-4acb-99b3-6c49c0075746",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6755450c-5d8a-47b1-ac34-4d006c60ceed",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c65ad187-8b88-43be-80ba-d30d5f0fbf14",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f14e1efa-bb0e-4454-8381-5bf8aec0849e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-14T04:29:01.3297627+00:00"
},
"company_sector_id": "622def22-2462-4746-837b-56381467fa83",
"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": "9663aea4-26a0-41c9-b2af-500db6d5378f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "67bf9145-f6b7-4fa8-84eb-d936b8d60390",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0b37da0b-b5b2-419d-871e-086ed1a7fee5",
"account_manager_user_code": "sample string 56",
"company_status_id": "9ff55188-49fa-4735-8230-6d3dcd7f5ddb",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-14T04:29:01.3297627+00:00",
"id2": 60
},
"db_language_id": "2d97a726-c946-4513-b472-990053307260",
"db_language_code": "sample string 7",
"db_title_id": "78e684c8-b016-4e8c-b593-99e28da494dd",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-14T04:29:01.3297627+00:00",
"create_date": "2026-08-14T04:29:01.3297627+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-08-14T04:29:01.3297627+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.