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": "60ce66b6-04c4-4b66-b13a-ecebd71d7c8c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8f71a0df-e2bd-428e-8556-6c65f05735a6",
"company_code": "sample string 5",
"company": {
"id": "92cb6328-899c-49ff-9d3d-a6394e4276c2",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-21T10:21:37.252+00:00",
"sales_territory_id": "b4baf6f8-99f2-4ff6-957d-082d2168a06e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "dec01c81-f3c3-46f0-aba7-febb66471df7",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4d1e0988-cf4d-4c92-bc34-714f735a8cc0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "412c4288-a72d-4ca8-8b17-fe7649e87de0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "636a8658-f932-4ce0-b250-290a0227022d",
"db_currency_id": "d38a75d7-f4de-47ec-b062-245d1492acf8",
"db_language_id": "7b3582fe-ebcb-4982-b0f6-76a2c7158d69",
"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-05-21T10:21:37.252+00:00"
},
"modified_dateutc": "2026-05-21T10:21:37.252+00:00"
},
"marketing_segment_id": "4dea1f35-c0a2-418d-ad2d-169d1c54a344",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7f9b39ef-b8fc-4682-9558-c299d60befc9",
"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": "34a60f23-905e-4c5e-bfb5-7a41d0c65ad6",
"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": "0d8d1ebd-310f-4879-b2db-27f60fc0bb5a",
"db_country_code": "sample string 28",
"feelist_id": "4491b3a8-6eec-481d-9f24-1f6ae4715410",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6e7f228e-ea39-4d5a-a98e-e856ac2997ac",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "227b967a-9ae7-4b34-be08-2c138ff58a92",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-21T10:21:37.252+00:00",
"db_currency_id": "b1311b24-4b05-4285-81c0-2a8481eac54c",
"db_currency_code": "sample string 10"
},
"company_type_id": "0dad4347-3bf4-4e2e-9ed4-0c22dae1dadd",
"company_type_name": "sample string 32",
"company_type": {
"id": "82b35d55-ee75-4239-8136-72cb09d4c87d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e4f7cd28-1fdd-4967-86e6-10bdd38e8777",
"sales_organization_code": "sample string 5"
},
"db_language_id": "46f95310-b666-40d0-8749-3810a8321a0b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "29240e0d-9622-47f1-83f6-eda135b78c57",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f62368d5-1313-486d-838b-50a8c2bc4f1c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ecf4e2a5-bc07-49df-963d-50337d089411",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-21T10:21:37.252+00:00"
},
"company_sector_id": "c424ed32-d8a5-4b29-a5da-9f011c88ce4f",
"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": "8c45a7f6-ea61-43f9-903e-1714c85d6a64",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "23dad6d2-eeab-4544-b197-6e5aa1906715",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "fe8d269d-64c1-4939-9f83-c934a5b6ee17",
"account_manager_user_code": "sample string 56",
"company_status_id": "43131971-9b9e-42d6-9eb2-b9ec17c228e9",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-21T10:21:37.252+00:00",
"id2": 60
},
"db_language_id": "799b9160-4829-49f7-8cb8-5db6d2b9ade2",
"db_language_code": "sample string 7",
"db_title_id": "54e2a4c0-8f14-43bf-a001-33cb561428de",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-21T10:21:37.252+00:00",
"create_date": "2026-05-21T10:21:37.252+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-05-21T10:21:37.252+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.