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": "4b5debfe-1fba-4991-99f6-3ed58f9fbb97",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "943182e2-5ac9-45e3-a2ab-d6fef8840b31",
"company_code": "sample string 5",
"company": {
"id": "5532be6a-e66e-40df-8da5-a97c036f0c3a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-13T15:19:37.7231482+00:00",
"sales_territory_id": "35a72a2d-a46e-4a5f-a041-c47ca88feb5e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "72e04d31-1b83-458f-8af2-15d54910ebe9",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e563f252-147a-440d-b897-cf220458c1a8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "82829e6e-5d95-42d3-b8b4-15ddd8ba941a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5b8af5d7-7a77-45ae-9e7b-ad5a78e2986c",
"db_currency_id": "b3bf3c76-91a6-4cc3-8d30-756cd83cd24d",
"db_language_id": "696abd6c-946c-425a-a50e-8579cf27a8cc",
"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-03-13T15:19:37.7231482+00:00"
},
"modified_dateutc": "2026-03-13T15:19:37.7231482+00:00"
},
"marketing_segment_id": "7811b59b-70ac-46a0-872b-4e620623f738",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3a40a37f-66ae-4f75-be1e-6ece78cf05b8",
"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": "ef298c9c-6839-4c02-9251-ba56d5d3f1f3",
"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": "2cb9173a-6aa0-42a2-9914-5d084bd99427",
"db_country_code": "sample string 28",
"feelist_id": "72d4a23a-349b-4020-b77f-e196325aae84",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "82855361-4a36-4e7a-89da-1268eb0da5a4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0c5fcc53-cb62-46d0-8a8d-b57c9d9b9c6a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-13T15:19:37.7231482+00:00",
"db_currency_id": "a9a745f3-7915-4b11-9520-fadfad7c925f",
"db_currency_code": "sample string 10"
},
"company_type_id": "8e6b0ae6-e4db-47e9-9667-e42e1b1b65f3",
"company_type_name": "sample string 32",
"company_type": {
"id": "2707058f-73a0-456f-92bc-515dd2ae6e3c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9dd644a9-6d06-4bf7-86c6-2e7261c6f6bf",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f12805f8-4f1b-4685-b1c8-dc0cac0ae579",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "117ddc84-b902-4a57-8017-e5e5f94015bd",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "00be6897-88b6-4c76-a4a6-db84943e7af1",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7fc6d2f6-17ae-47b4-9341-b423b67238f9",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-13T15:19:37.7231482+00:00"
},
"company_sector_id": "05ae03f1-e67f-4dac-9ede-d1556d6f7284",
"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": "b699ff5b-44a8-4062-8c9d-0a74edc35a37",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a3a71f88-8a42-4ce6-bf6c-7b21bea578d2",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "be467004-1c63-492b-9cd0-9e3f04c1b2a0",
"account_manager_user_code": "sample string 56",
"company_status_id": "416498a8-a4f9-4123-8673-e7bb6202583b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-13T15:19:37.7231482+00:00",
"id2": 60
},
"db_language_id": "57a46c71-f7aa-4e55-b0c1-432e7d3c9426",
"db_language_code": "sample string 7",
"db_title_id": "e558f214-b434-438e-866a-8c9718f1ce10",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-13T15:19:37.7231482+00:00",
"create_date": "2026-03-13T15:19:37.7231482+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-03-13T15:19:37.7231482+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.