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": "0f8eafcb-9405-4e3c-9f7a-f643e3f6c039",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "6cd8dfc7-ce78-4029-9287-0685b0df6fed",
"company_code": "sample string 5",
"company": {
"id": "3624f31b-e9e1-4db6-8219-df476560bc98",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-13T04:52:59.1450206+00:00",
"sales_territory_id": "f75ec6df-3cdc-4fbc-babb-226321bbb5d9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c01e84ea-6b33-45d2-b894-c86cffaa7e24",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e79a36a4-d5c8-445f-b216-41ed08c587cb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8efefc58-c38e-4df8-a675-759f3c35bbc9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3be9f347-52a2-4617-88ca-049fe2cd0c7d",
"db_currency_id": "79e14dd2-ba34-4830-b386-3649a611c987",
"db_language_id": "7349a92d-1d27-4f3f-b215-fb5bf6efb4c0",
"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-11-13T04:52:59.1450206+00:00"
},
"modified_dateutc": "2025-11-13T04:52:59.1450206+00:00"
},
"marketing_segment_id": "2c5d66ae-7bcc-44af-937c-e36aee727850",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f51b8009-b656-446c-9772-1c87ed722333",
"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": "0e223254-461c-4f18-973b-02d6acd54b19",
"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": "a5e10b2e-9999-4610-9cf7-1d96031d8384",
"db_country_code": "sample string 28",
"feelist_id": "a2d7c526-e645-49e3-93e9-a080d4e89cd5",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "00d4fa21-70c1-4661-9592-92cf0909faa6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "4e9dba69-be19-4b7c-b877-826b15d425d7",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-13T04:52:59.1450206+00:00",
"db_currency_id": "a25c1d35-84a6-41df-8a3b-bbda6313a730",
"db_currency_code": "sample string 10"
},
"company_type_id": "0e321655-9261-4029-ab98-df58d225fc58",
"company_type_name": "sample string 32",
"company_type": {
"id": "b4fedec8-6a1f-425f-97c4-b10f0f310a61",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c822b181-ca16-4e46-9bbf-c37f4d2d4184",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ea40723e-48dc-43ae-af95-55f9da841223",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "107f6911-3865-4897-840b-8756acb996a5",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "9f8e8c57-3238-4f39-bd0f-b7e8e44f75d4",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "40b8382f-3e34-4914-b301-ad46e65495a8",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-13T04:52:59.1450206+00:00"
},
"company_sector_id": "b8e40e60-826e-46dd-8052-7bd4b2bf4736",
"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": "49bc77f7-3f43-487a-8b49-f7bcc3b5eee6",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "39aed71a-f9b2-4195-aaff-39162d3eddae",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e7cfddef-1a97-42da-a85d-86746c920bb5",
"account_manager_user_code": "sample string 56",
"company_status_id": "1505bd26-f8cd-4bc3-b473-04df422035db",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-13T04:52:59.1450206+00:00",
"id2": 60
},
"db_language_id": "c3895e8f-b7be-41b6-87cb-28fbfcfb1bb9",
"db_language_code": "sample string 7",
"db_title_id": "329fc7cb-5fcd-4f16-9a68-f4fab1f5ebdb",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-13T04:52:59.1450206+00:00",
"create_date": "2025-11-13T04:52:59.1450206+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-11-13T04:52:59.1450206+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.