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": "0ef2ec01-1cdd-48a3-8126-c7fd1eafcb64",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2ad138e7-0236-492b-8ed0-8c49b06a8708",
"company_code": "sample string 5",
"company": {
"id": "0b7d81ea-7e97-4202-a0ce-bd590b572b19",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-12T08:21:24.3903738+00:00",
"sales_territory_id": "a857f65b-ca49-45ba-98a3-2f73822b7c7e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7b989866-3945-4f84-bb2a-2a4f89169792",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6d2e1681-2bef-47ca-abf0-beaf760d8427",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2b66cb5f-d70a-4d67-add0-4f85558a0995",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bc3d4267-8833-4a77-ad28-9b9bd0c410ee",
"db_currency_id": "6d59731d-bc99-4a73-b48f-9623866dfede",
"db_language_id": "e58c6768-fd84-464b-aa9b-60d9c8ec4695",
"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-12T08:21:24.3903738+00:00"
},
"modified_dateutc": "2026-07-12T08:21:24.3903738+00:00"
},
"marketing_segment_id": "4dfc0971-5d66-469f-ab4a-05c5d469a9cb",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "23ae5de5-72f8-4f8b-bac8-4aed75c47ad0",
"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": "992771ea-dc7f-422c-9d42-26d6ba3a3024",
"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": "45f5df52-3573-418e-bc2f-a59a540834f5",
"db_country_code": "sample string 28",
"feelist_id": "459198cb-e7eb-410d-90dc-28039b9d4b15",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "25d555e0-280b-4a21-8853-a9f8f5b004de",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "fcfc4bdc-7f92-4eca-9efc-6e2482afb6d5",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-12T08:21:24.4059976+00:00",
"db_currency_id": "79870768-f4b9-4bce-9c82-f215d71a7114",
"db_currency_code": "sample string 10"
},
"company_type_id": "cc7e1535-287e-4a54-a1b5-19551d94083a",
"company_type_name": "sample string 32",
"company_type": {
"id": "651a843e-0d53-4867-95fe-63680aace7b0",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "af6e555b-27ca-4df6-99f5-c5eb9ad2a461",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0472c28e-12fb-4b22-8632-d5273a45c5c7",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "aa6e15c0-36ed-4f10-bc14-7f40387a35b8",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0b59f431-64c4-4acd-8b6f-dc87a6692a55",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2c994e7d-d5be-4f7e-a328-aac331c3f680",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-12T08:21:24.4059976+00:00"
},
"company_sector_id": "2a6e407c-b2be-4be2-a38b-1145f48854d2",
"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": "f665122c-0960-4e69-94d5-707b2699ef10",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "419d9327-92b0-462d-9885-33edb03f95d9",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "24c2ec82-8f6b-4d6f-9016-5ed4283425a2",
"account_manager_user_code": "sample string 56",
"company_status_id": "cbaa06ea-5809-46ba-869c-3bdccf454615",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-12T08:21:24.4059976+00:00",
"id2": 60
},
"db_language_id": "cd01330c-396f-492c-b4ea-51f0e860f400",
"db_language_code": "sample string 7",
"db_title_id": "03444a7a-b4fb-4baa-9764-6843c25e9392",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-12T08:21:24.4059976+00:00",
"create_date": "2026-07-12T08:21:24.4059976+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-12T08:21:24.4059976+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.