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": "390d41ed-25f4-4fdc-81f2-6e1892bfefb3",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e8f566b8-175d-4147-9d2e-e2c1b5611b07",
"company_code": "sample string 5",
"company": {
"id": "c2787940-9eae-4f4c-8edc-3b9194996d30",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-03-31T21:20:43.9989591+00:00",
"sales_territory_id": "cd7d6cf2-e318-4407-9c2b-357de8f764b0",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c01c1b5a-c691-46f0-a261-7b100973def4",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "281442a1-30e9-47c2-8b4f-2a4c4229459b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9a80079a-d3df-4afe-86f5-30164dc03dd6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d24c2c49-c7f7-421c-a0f5-e2012d2f8d2f",
"db_currency_id": "47650cf3-698b-4b65-a39a-f7b6d3609204",
"db_language_id": "5d01069c-48cf-4a1c-9ad1-9fcce022c407",
"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-03-31T21:20:43.9989591+00:00"
},
"modified_dateutc": "2025-03-31T21:20:43.9989591+00:00"
},
"marketing_segment_id": "41fe607f-de38-4a37-8473-469389c4706a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2c3e2a69-1498-4fde-a393-aee25dbb9386",
"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": "037833a6-7eec-4936-a1b1-0b803fde64e8",
"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": "498f738e-49b8-46a6-b38c-e95058cf241d",
"db_country_code": "sample string 28",
"feelist_id": "d7bdeaa9-3af7-490f-b5c0-5c0b53da34af",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3ba47868-6ab9-43ab-8d3d-314c0132d06d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "41793914-60f2-49ca-a576-1677610ecd9e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-03-31T21:20:43.9989591+00:00",
"db_currency_id": "261e30d5-1c0d-490a-a59e-7f3774551325",
"db_currency_code": "sample string 10"
},
"company_type_id": "73754665-846e-4a1b-97c4-3f8854b39836",
"company_type_name": "sample string 32",
"company_type": {
"id": "8d8c90f8-d847-4658-8799-301428df6ea0",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "115fc570-a4f9-4e49-b9c7-91e1831f7725",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b0841d4c-0f1b-4347-ab18-942db460fd1c",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "74cb9165-65cf-4d82-b7b9-49f3103061c2",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1d22b4e5-54cb-4817-80f9-185f049514d4",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ca614367-7094-43a7-a2ef-313a43ddc8b4",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-03-31T21:20:43.9989591+00:00"
},
"company_sector_id": "6279be03-2ab5-4f3f-bb16-6c3e8c9477f7",
"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": "5d5a4765-ca27-4b67-8734-1072b93cd0f0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a82a4e05-3322-4fac-8f72-91cfb2a828e1",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "afa04648-855e-4631-9780-c4df3887e868",
"account_manager_user_code": "sample string 56",
"company_status_id": "3715537c-8a6f-40d7-8921-7e4cc9c65fa5",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-03-31T21:20:43.9989591+00:00",
"id2": 60
},
"db_language_id": "fbaaec72-c5d5-4f51-93ec-587b85248205",
"db_language_code": "sample string 7",
"db_title_id": "3fcdfffe-2b84-4014-9748-13a8f8f70ec4",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-03-31T21:20:43.9989591+00:00",
"create_date": "2025-03-31T21:20:43.9989591+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-03-31T21:20:43.9989591+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.