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": "a426355b-5615-45c8-99b9-9b42ceb67c3d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "5bb771a4-1850-46c1-adc0-dbfa97df241c",
"company_code": "sample string 5",
"company": {
"id": "375e9bb0-4572-490b-875d-09cb9c3c6ce9",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-11T01:48:35.9636777+00:00",
"sales_territory_id": "2a341ae1-8239-4d39-a754-21739939d2b0",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "510875d6-56fb-4048-89d7-46ae245ba0f2",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ffe32779-b9a1-439a-882c-779809620e54",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3af9c0f9-1293-420f-ae87-91a060e8de19",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5b417922-ff13-47a8-9e10-09faf26b7e9d",
"db_currency_id": "8056add7-7f72-4f35-98de-c1900f630b0d",
"db_language_id": "9f7dc32f-6025-4137-8d38-a9f0a0474611",
"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-11T01:48:35.9636777+00:00"
},
"modified_dateutc": "2026-07-11T01:48:35.9636777+00:00"
},
"marketing_segment_id": "73e919f0-07b5-4996-8b9a-7efe7b595717",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "012dc270-f7b5-40bc-a938-a53d034a9569",
"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": "6b740595-e7bf-4016-95e3-a3686f73b0f3",
"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": "580e0f32-5637-4281-9b0e-f0d55df86af8",
"db_country_code": "sample string 28",
"feelist_id": "212cba17-b7d4-476e-9a1b-dd7c2c09df44",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5d3ac23b-40ed-4f15-be61-4ee22e42a627",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a58fee9c-407b-4afb-b769-601d932e3f25",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-11T01:48:35.9636777+00:00",
"db_currency_id": "f888575a-b569-4043-a586-cf560bd6638e",
"db_currency_code": "sample string 10"
},
"company_type_id": "963b94b1-2218-4054-991a-eb480df1d87b",
"company_type_name": "sample string 32",
"company_type": {
"id": "0fa96951-d615-41b0-9295-d6f2abf46835",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0e2011ae-9ad7-4213-a09d-e182be3ecc7f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "548d8dd2-0a47-4293-af47-7e5714e78b21",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d24c2c3a-e59e-4a66-bcbb-93cf3f49df90",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8e990463-6fcf-4504-8bac-c7404066bcbf",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f262a736-b567-4f09-8008-4a39af8cf40c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-11T01:48:35.9636777+00:00"
},
"company_sector_id": "6262c73e-0155-4ae1-8b0c-ba064f5dd3df",
"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": "cf46f809-6005-4e74-a857-7bffce203a45",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c7f97cc0-b3a3-4a60-8d6c-d64c8b844216",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ff5751e2-cc0e-47ad-9500-24fcd1081153",
"account_manager_user_code": "sample string 56",
"company_status_id": "973e11a3-1b0a-45c6-945e-d9f2ad8d28c9",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-11T01:48:35.9636777+00:00",
"id2": 60
},
"db_language_id": "c822252d-61af-4c38-8166-7cce62e9e285",
"db_language_code": "sample string 7",
"db_title_id": "2dee0cd9-4d9f-4022-86cb-d23538b1f038",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-11T01:48:35.9636777+00:00",
"create_date": "2026-07-11T01:48:35.9636777+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-11T01:48:35.9636777+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.