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": "5bd494ca-85bf-41fc-8024-7593fa63e39d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ae91a66f-cee2-4de1-9fd3-ae140feffad9",
"company_code": "sample string 5",
"company": {
"id": "e74bb034-96f9-4fd8-a970-c106936cd25e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-26T04:50:39.5818415+00:00",
"sales_territory_id": "3d4f5f91-b52c-495b-a1e9-6087434948ed",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8b9bde9b-d8cd-4185-b5b0-03b9fd96f0a4",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d8d3079b-6459-4b06-967c-1dea0a5b30a3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "dae5883f-6f84-4c98-af01-c15fc2d65bbe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9584e17d-495a-4531-bec1-015b6f51f465",
"db_currency_id": "5028ef50-2cd2-4ffd-ad13-c20a997f6ce0",
"db_language_id": "e418f7f8-727d-4e18-b892-a9d3a4f897d4",
"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-09-26T04:50:39.5818415+00:00"
},
"modified_dateutc": "2026-09-26T04:50:39.5818415+00:00"
},
"marketing_segment_id": "21aef977-7b81-427f-885b-0bb3c7e6f419",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4bf234c6-7c43-4090-b5af-2cced2f7d303",
"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": "f9d76526-afa3-4a97-8838-c372c53e036f",
"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": "5a8df026-e185-42d6-9254-43a460722e92",
"db_country_code": "sample string 28",
"feelist_id": "5f25b898-7b13-4797-867a-b7fc0e33edf3",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c291c056-ef7f-4e99-b079-fa5dba0c3c1e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ce7a57e4-a6c2-4b7c-b8b9-c7d4ab4af42e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-26T04:50:39.5818415+00:00",
"db_currency_id": "1c549252-3dc6-42c7-84e6-317e25525dae",
"db_currency_code": "sample string 10"
},
"company_type_id": "d87cb59c-68f7-4005-9af6-ef7988a82ad4",
"company_type_name": "sample string 32",
"company_type": {
"id": "08183b19-6491-4081-ad83-f61207d7e5dd",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f62c3bf4-9195-42c6-815b-f317d2c1e1f4",
"sales_organization_code": "sample string 5"
},
"db_language_id": "324d890d-4ebb-4516-915c-8cd367004d39",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e828b8fe-d40e-4199-bfec-a168d319a82b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "07d845b4-3f5a-43d7-8a36-60087cddd5e2",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7231d46d-911b-49a9-baeb-3de74ecb4e2a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-26T04:50:39.5818415+00:00"
},
"company_sector_id": "fa3be381-c026-41d2-9fdd-cd5a0c9106eb",
"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": "d694e91a-75a2-418f-9d96-7a8ba3eeefda",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c1c6ae5d-8615-4135-ac96-30354f2687f0",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8e5f0d96-4253-4f80-971e-0ac373bc8d00",
"account_manager_user_code": "sample string 56",
"company_status_id": "e1feee5b-acad-40fe-8864-a4a1608a9e8c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-26T04:50:39.5818415+00:00",
"id2": 60
},
"db_language_id": "9b928ccd-7d8c-41c9-b20d-658979925a53",
"db_language_code": "sample string 7",
"db_title_id": "0119a0af-a4fa-4a55-9bc0-6f5d0161bd34",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-26T04:50:39.5818415+00:00",
"create_date": "2026-09-26T04:50:39.5818415+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-09-26T04:50:39.5818415+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.