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": "c4bbf464-1df5-4346-85bb-29a061671e56",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "70b2dbed-ba52-47d0-984e-bb9f97144bc0",
"company_code": "sample string 5",
"company": {
"id": "40629ef2-13e7-43f8-bdca-ff1e640aaf5b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-01T17:41:59.4816471+00:00",
"sales_territory_id": "fe6b27b4-eb22-488d-81d6-525fccfe88f5",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5f60473c-e262-4470-b486-586b3c853582",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b6d4554d-f8c5-49fc-956c-0fb36a2e677a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d0647a9d-288a-4067-8520-6c7608851a35",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ff1e5475-b860-4c8e-b1c3-b545cc48a674",
"db_currency_id": "369e76a1-af82-461e-a9cf-94ca4289036f",
"db_language_id": "b84739b4-aa91-4e3a-8198-15ea14927f82",
"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-01-01T17:41:59.4816471+00:00"
},
"modified_dateutc": "2026-01-01T17:41:59.4816471+00:00"
},
"marketing_segment_id": "f1d8f07d-ca28-443a-aad4-307850914718",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "bd9a2c20-1203-4282-aca2-913a16c757eb",
"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": "cd767873-e268-4979-a092-604b7ef224b3",
"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": "b952ebf2-8cd8-4c47-984a-95dc683b7408",
"db_country_code": "sample string 28",
"feelist_id": "965e5b52-ad1c-4c88-9dc6-99a3fe52b864",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "0ca1265a-c35d-478d-b9d6-fdcb70624e78",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "82fd27b9-5d52-4dde-aad8-156931b469f3",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-01T17:41:59.4816471+00:00",
"db_currency_id": "0d48d1ab-bd48-4607-b8da-e126813c89cd",
"db_currency_code": "sample string 10"
},
"company_type_id": "4f21621b-05af-4f34-b8e5-c2ac16078929",
"company_type_name": "sample string 32",
"company_type": {
"id": "ca4d5d2d-9593-4202-a44c-094ef121f470",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "04b35f3d-40af-4c05-9601-75f65368fbd0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ffda9aac-e5a4-43e6-8c81-e6ba1ceead05",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a53e38d7-4066-4714-9dd2-50f8debf80e4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "66839a88-6156-493d-b3a3-cf2e65c6617b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "69c39593-9919-42ec-b305-daf4802e4383",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-01T17:41:59.4816471+00:00"
},
"company_sector_id": "88387db6-7709-4ace-bbf4-8c8bdd0b230f",
"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": "ade9c89d-45b2-4dff-97d6-c8ba38a5a389",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5a0e9f01-c1c9-4e1d-a7ec-32c592a571e6",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ae457166-a50e-42a1-9afd-53f4b991b6c5",
"account_manager_user_code": "sample string 56",
"company_status_id": "d8b9c039-f643-4fbc-8f8b-3ad305510412",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-01T17:41:59.4816471+00:00",
"id2": 60
},
"db_language_id": "44b634a8-3b8c-411e-af45-5b1d85703e24",
"db_language_code": "sample string 7",
"db_title_id": "a6e1e075-5bf4-4d57-8873-e64971147c29",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-01T17:41:59.4816471+00:00",
"create_date": "2026-01-01T17:41:59.4816471+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-01-01T17:41:59.4816471+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.