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": "1111b84b-7f35-462f-8784-fb9343186a83",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "142a2a9d-9016-4fb9-ac0a-7633e7983c38",
"company_code": "sample string 5",
"company": {
"id": "46d8c8a6-291d-4509-8e7b-575449b3782e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-04T21:37:28.0649813+00:00",
"sales_territory_id": "1489ea10-f3b4-462e-9bd4-c0e28ac3cc3a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b70bfffc-ca2f-41bd-955d-25bf52c83a5f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6659b94f-8a9a-4312-8850-51610ab34e12",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6aa89087-fed6-4be4-8394-a5b28b5e4e8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0ba6b271-f217-472d-abc2-3ced8492d486",
"db_currency_id": "549d4b4b-7850-4f57-be06-5cf14336b075",
"db_language_id": "04cd1d36-16bf-40c8-8235-0e0d24f6541f",
"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-07-04T21:37:28.0649813+00:00"
},
"modified_dateutc": "2026-07-04T21:37:28.0649813+00:00"
},
"marketing_segment_id": "409f1486-64c2-4c99-8e85-0c517ad3bad2",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a5add8eb-4480-4c5d-93d8-60b08335c7d9",
"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": "b29b98d2-6cd9-48c4-b468-6c19f2849014",
"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": "3aa6a33d-7cda-4284-ae6b-ad743aed33ea",
"db_country_code": "sample string 28",
"feelist_id": "75558e0d-23ba-41d4-81c5-f1276d460423",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "71d23610-d78b-4e71-818b-b9e781e89fdd",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "4f24a7de-cc57-4872-b09a-f467dc76a620",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-04T21:37:28.0649813+00:00",
"db_currency_id": "59459d37-36f8-4090-9f42-4fd4fb61c0d5",
"db_currency_code": "sample string 10"
},
"company_type_id": "3b67afe9-446f-47ff-99e6-54cc0169610e",
"company_type_name": "sample string 32",
"company_type": {
"id": "d7dbd3dc-0df3-49a3-842c-2804c5937691",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e84b1a89-2678-45ad-a619-e250964a0158",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f94a175d-37f0-484a-8c61-246254cbdecd",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a04555c5-6d57-48b7-aa6c-d7dffea30d22",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "efbe4a39-0e31-45fd-9980-a80497032615",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "1fd96318-9aa2-47c1-897c-15671e18811c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-04T21:37:28.0649813+00:00"
},
"company_sector_id": "fe0fd46f-7bed-4088-8ae5-f748229cc132",
"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": "937afd6f-da5e-4637-961c-91367695354f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f627e9d4-88ce-4d11-b61d-cf67b975d80e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3e269bff-9a20-45a8-b75d-1152d7a1b712",
"account_manager_user_code": "sample string 56",
"company_status_id": "af57d766-4b29-4eb1-8fc1-627a1313c396",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-04T21:37:28.0649813+00:00",
"id2": 60
},
"db_language_id": "e85c9bf6-3127-4a65-8da7-88c5214d709f",
"db_language_code": "sample string 7",
"db_title_id": "4fde6ef4-5f1c-4033-8a57-9d48d117623c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-04T21:37:28.0649813+00:00",
"create_date": "2026-07-04T21:37:28.0649813+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-07-04T21:37:28.0649813+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.