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": "2940ef84-8283-432d-9bcc-49cb5570933c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "77281be1-63b7-413c-bc15-07a3bb1f9495",
"company_code": "sample string 5",
"company": {
"id": "991d7940-8f9b-46f7-beb8-8d8b1b277dea",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-25T11:40:04.5669322+00:00",
"sales_territory_id": "d59fc221-b977-40fe-9a18-f1770c2b5176",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d313848b-882f-4cb2-9514-f31f22a515d5",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "888c14de-ab2b-4918-8ea7-9aada10e0016",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f2aaf34e-f74c-41cb-a7f8-f4b882142b08",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7173e87e-fa4f-4037-8c87-4e99c0ff4f98",
"db_currency_id": "efa5fee0-2683-4726-900f-e7a6e87b2626",
"db_language_id": "d7e75ab9-ae9f-4408-88f1-06bb3c729415",
"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-02-25T11:40:04.5669322+00:00"
},
"modified_dateutc": "2026-02-25T11:40:04.5669322+00:00"
},
"marketing_segment_id": "76b6d6c9-2210-485e-b668-121586e74b8a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f19c08a8-a4f0-4828-ae03-3259a1923c97",
"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": "68d3ac62-141a-4c54-9b44-cf35ad567519",
"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": "c46d9005-4b6a-42f0-be7d-834812039910",
"db_country_code": "sample string 28",
"feelist_id": "32707a97-1f7c-4538-909f-2f0d4f3f0342",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5bfaaf5f-6013-4475-a398-f4c62c8b3dff",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "737afc22-2991-4ddc-b537-b24fcb43ef2c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-25T11:40:04.5669322+00:00",
"db_currency_id": "2a2864a3-e2b8-4151-b949-6cb4639b4012",
"db_currency_code": "sample string 10"
},
"company_type_id": "3c92fec0-896d-4c1b-a454-96499e5fbcb3",
"company_type_name": "sample string 32",
"company_type": {
"id": "97d3ce50-9220-4d42-b800-4605989fd879",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1baeec48-9abb-4bad-a33e-84206fdb3657",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2f1eb861-93a2-4b57-a95c-1386984f2f53",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9c7a0065-387a-4abd-94c0-bd5f28064945",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "bd8af5ae-1be2-4188-93eb-8c03e9c6fcb5",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a2ba377c-f1a1-4d92-8923-4a1e4405ff2a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-25T11:40:04.5669322+00:00"
},
"company_sector_id": "52865ee4-06a7-4e10-8d65-b4e81e7b7a48",
"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": "5d3c1c13-9344-4fef-a0a5-0a839c7b4626",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8cacfc1f-db90-4443-81b6-41c99a6edac7",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0cc46d4b-30d7-43d2-9711-2d4ab4b1dfaf",
"account_manager_user_code": "sample string 56",
"company_status_id": "a846c7f3-e23b-48f6-ba1b-e76ad2d6a2c6",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-25T11:40:04.5669322+00:00",
"id2": 60
},
"db_language_id": "0d693552-739a-4f38-80a2-9f21d4e4d1c6",
"db_language_code": "sample string 7",
"db_title_id": "f0ca0e6b-5753-4c86-8005-0efd36a370fa",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-25T11:40:04.5669322+00:00",
"create_date": "2026-02-25T11:40:04.5669322+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-02-25T11:40:04.5669322+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.