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": "3d61d2d7-e667-4e4d-bd43-8be03117a2e1",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7854d376-1b1f-47c4-9bfa-12f33a253cb3",
"company_code": "sample string 5",
"company": {
"id": "70424e59-aeae-4d17-9e82-840ac92ef0d1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-17T19:47:50.7315837+00:00",
"sales_territory_id": "df2afde1-a3bb-45b4-a833-4497ac801273",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b28ed389-f0c9-4647-9c42-7dd8990ad262",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "79d0a476-fa67-4232-81bf-40c6d253ca28",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2baa313b-7e2c-440c-8403-3a0a3f4b7a3e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "53b72d6e-d6e6-4e80-9b5f-de7d543321b1",
"db_currency_id": "2c3172b5-b649-4d0c-9aaf-1a70768c90bb",
"db_language_id": "626fd423-bcc8-4b02-b284-86fbf1fa9d30",
"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-11-17T19:47:50.7315837+00:00"
},
"modified_dateutc": "2025-11-17T19:47:50.7315837+00:00"
},
"marketing_segment_id": "4735c7c0-e4c7-4068-9553-7457c7159b3f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6828a0db-b4c9-468a-bc7d-cbcae33e9cdb",
"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": "87a12204-59b3-4014-ba30-588d4a1a2112",
"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": "bbe8dc81-5af1-47f5-9394-3bcf9d60e807",
"db_country_code": "sample string 28",
"feelist_id": "1e3a64b9-ab1d-4ba7-b1b0-17706e43e44e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b87bbbc2-7a6a-47f4-80d7-3ba1486cf5eb",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5b71b928-410d-4091-a964-6cd8310110bc",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-17T19:47:50.7315837+00:00",
"db_currency_id": "339b70ea-5c13-4414-8eb4-ac97c3f53da2",
"db_currency_code": "sample string 10"
},
"company_type_id": "016861ec-89f2-4240-a340-5719fe2caf3e",
"company_type_name": "sample string 32",
"company_type": {
"id": "2304e4eb-0330-40a1-a332-a55fbda4058d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "239b85fd-2b01-4a62-9f57-b82c9d093001",
"sales_organization_code": "sample string 5"
},
"db_language_id": "49a81b3d-c425-4225-9ea8-4245440cade9",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8b3ee1e1-68a3-47f6-9260-f053f36e5f7a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "3a213efe-e809-4468-ab5d-11e99362cd0c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a0c40da3-fd48-4487-931a-c2e9471e4fe6",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-17T19:47:50.7315837+00:00"
},
"company_sector_id": "ce9657c2-2e39-4272-91cf-5e8b90aaa666",
"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": "9efd893a-4b67-4fd4-9f7c-d3c7c1a80373",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d368f1a1-7f67-4da3-ad94-4bb5f16cfe1e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "35f2975a-96d3-46a3-bdbc-74dd7d887f25",
"account_manager_user_code": "sample string 56",
"company_status_id": "0a37b379-fb61-424c-8c3a-45a77eb53eb3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-17T19:47:50.7315837+00:00",
"id2": 60
},
"db_language_id": "08ad4d8b-cdd3-4933-aeaf-389ab1f9ff53",
"db_language_code": "sample string 7",
"db_title_id": "e6ffee10-3e93-41c8-b2fc-7f37efe2d5a0",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-17T19:47:50.7315837+00:00",
"create_date": "2025-11-17T19:47:50.7315837+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-11-17T19:47:50.7315837+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.