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
{
"id": "6206c50f-2123-4a93-aa09-266579b5c46c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c826a88f-0c07-4194-83aa-843d5624b574",
"company_code": "sample string 5",
"company": {
"id": "1c289e37-2396-4fb5-9e28-201a74033668",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-13T04:51:37.6885505+00:00",
"sales_territory_id": "d678a3ec-6e29-4cc2-982a-71f5aa572845",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "25601034-2cd0-41d2-b430-dc84878e4dd8",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0bcb5161-d8fa-472a-97b8-98fd2cbf601c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "84769114-3f9e-4728-bdb6-79d218357059",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eba88511-e0ed-431f-8529-42515ae37b25",
"db_currency_id": "35a57331-7f8f-4d4b-9a92-87da2549c3fb",
"db_language_id": "0eb82aea-b103-4c4c-84de-0336f9fa8a19",
"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-08-13T04:51:37.6885505+00:00"
},
"modified_dateutc": "2026-08-13T04:51:37.6885505+00:00"
},
"marketing_segment_id": "5966048c-a465-4afd-8246-dd1665ce613d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a1a70c22-e1d1-45ea-86d4-050f1402ed98",
"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": "7346a24b-ed21-4ca0-8a90-d79d227b8d5b",
"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": "16aeb451-ea30-4e66-9871-75b81f35d83c",
"db_country_code": "sample string 28",
"feelist_id": "e9f45ac2-c4c8-48ac-9193-1a43941d9489",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1a40a36f-f791-4c78-ba3b-783943611236",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e6f0d353-2535-4e24-81fe-ee31330390d8",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-13T04:51:37.6885505+00:00",
"db_currency_id": "bdd82f21-fa3c-4004-87e7-e8d77082c449",
"db_currency_code": "sample string 10"
},
"company_type_id": "60ed5c56-89f8-4c65-b58a-1d61fc565b76",
"company_type_name": "sample string 32",
"company_type": {
"id": "3e77e474-3941-4255-90af-4a3ea703b4a5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "716c54f5-3145-45d8-bee9-b7a71cf147a2",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ce92c55e-9498-426f-b1a7-7ebfbec38eba",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d6bb107d-cd43-42b8-a123-eeafc0db86b2",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "70405d21-28b9-43a1-90a5-a385ccf7b9fd",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5e82fef1-84ff-4e94-a28a-5f750f164372",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-13T04:51:37.6885505+00:00"
},
"company_sector_id": "b7b0c823-fcdd-4886-a650-71a8b4b7d8d3",
"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": "77b9ee94-bb79-481f-b5f8-65561449bfb3",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8912948b-dd2f-4f2a-b57f-9f7a040726a4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "51f4bfbd-23d0-4c5f-87f4-325357540889",
"account_manager_user_code": "sample string 56",
"company_status_id": "7d7723db-001e-4024-ad73-f73622575dff",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-13T04:51:37.6885505+00:00",
"id2": 60
},
"db_language_id": "45f370ce-34df-421d-b65e-7b88ed199fb2",
"db_language_code": "sample string 7",
"db_title_id": "0b4e3373-768d-401d-b359-c9e46f2b36cb",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-13T04:51:37.6885505+00:00",
"create_date": "2026-08-13T04:51:37.6885505+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-08-13T04:51:37.6885505+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.