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": "c051a11c-c38a-40b3-a518-9cf02402e0f2",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "fe9d28e1-1bf1-4e79-8a08-273a0472c576",
"company_code": "sample string 5",
"company": {
"id": "31fac935-2981-4513-a236-7cd3654688d0",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-21T07:43:22.7393403+00:00",
"sales_territory_id": "e12beb08-819b-4de5-bab2-42ec8f117457",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7e23b9d3-275f-4f2f-adff-cd981b1d1793",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "de262dd7-bd3a-45b0-843c-abf406b14a58",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6bbbd340-552d-403d-ad2b-0d77ef07918e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c5158c6a-8848-4b9f-b72e-b4697dfab958",
"db_currency_id": "d38dcaa1-3eda-48e8-bd0d-5f1e4042b98e",
"db_language_id": "9c6ec832-d797-43ff-8d17-ed0c5be06176",
"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-10-21T07:43:22.7393403+00:00"
},
"modified_dateutc": "2026-10-21T07:43:22.7393403+00:00"
},
"marketing_segment_id": "3b30a21a-fe79-4895-8791-e23b967f23b4",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "bb03317c-61cc-4d5c-b88c-6a87192ec0e5",
"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": "20b5d346-13c9-4d79-8159-9cb7d263c2c4",
"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": "df147cfb-4342-4bf5-9851-ce06c2e875e5",
"db_country_code": "sample string 28",
"feelist_id": "5e23ee0b-36cd-495a-a7f3-62fb5b134486",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "88e7fe86-052a-4def-be3c-f42616c3ba6d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "7409d0f6-5f4c-495f-8068-6f75b75b10d5",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-21T07:43:22.7393403+00:00",
"db_currency_id": "bb0412f9-35e3-49c8-bbb5-d211d97a02f0",
"db_currency_code": "sample string 10"
},
"company_type_id": "2c31abf4-6491-479f-be5e-dfbdba23202d",
"company_type_name": "sample string 32",
"company_type": {
"id": "897be05a-821a-453e-8015-14720c75047d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "362771d4-9a75-4bc4-91ae-f7077b99ad0a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "031aae56-f723-4ba9-b3b9-c9d0da0450d6",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ea2c850a-5ce8-4a17-9fc7-aa9f09d937df",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "221bacf7-309d-4cfc-b92b-560bf2cdf8f9",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "99477786-ea30-490f-be75-6f175cc3e951",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-21T07:43:22.7393403+00:00"
},
"company_sector_id": "34b28e1a-81ff-44d1-bb8b-4d2f47779e3f",
"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": "5d07cf40-c70f-4cd8-a53a-91bcbf692037",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0b93bdea-32cd-4a9e-b7eb-0114a9b34bf3",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a4270d0e-e262-4ab4-b61a-fa3fa9baa125",
"account_manager_user_code": "sample string 56",
"company_status_id": "4ea1d77e-ace5-4494-a147-7f2c315ac9d1",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-21T07:43:22.7393403+00:00",
"id2": 60
},
"db_language_id": "798ccb8e-3b0b-4a4f-a636-65897e268f15",
"db_language_code": "sample string 7",
"db_title_id": "2cfced0a-7484-4138-82c2-613797599d00",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-21T07:43:22.7393403+00:00",
"create_date": "2026-10-21T07:43:22.7393403+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-10-21T07:43:22.7393403+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.