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": "0325c810-4148-411f-a310-2d3b457e9639",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "09176a68-85de-4c44-9b2b-7e2c9218ecb4",
"company_code": "sample string 5",
"company": {
"id": "8413b324-8080-49b8-a846-0e3c3c1f3e49",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-14T03:58:51.3487018+00:00",
"sales_territory_id": "d40bafa6-4c87-4838-9ee2-41a3a03f0990",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f8e71a45-3cfd-47a9-9d21-a69c63ca7775",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e2979eb0-197d-42c8-80cb-496a3c467671",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "05d9b2ba-4ebd-4deb-8c38-87a07f22347c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9c0be4d2-a1f6-41a5-ad3b-e4808f3887f5",
"db_currency_id": "17cb1f74-4246-442d-b699-a32c98ae6480",
"db_language_id": "bbe393a8-856a-474b-9644-5f35ecc938b0",
"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-14T03:58:51.3487018+00:00"
},
"modified_dateutc": "2026-07-14T03:58:51.3487018+00:00"
},
"marketing_segment_id": "a59451ec-4fec-4cff-a17f-9b5ad50a4777",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "96fbc527-c66b-463c-85ae-827e9dd80405",
"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": "9bc94dc9-9d9d-494b-92f5-19fcad959d77",
"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": "9f888973-27f1-490c-84fe-2ed29c21bfda",
"db_country_code": "sample string 28",
"feelist_id": "c25b43b1-e1f4-4540-8c6c-9c3bb00f416d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a2e702b4-848b-4255-a3a8-3406935f0c2b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ba6f1cbf-1b54-4600-a425-3c747b50a157",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-14T03:58:51.3487018+00:00",
"db_currency_id": "a8c71935-8bf1-439a-9052-de168d2ebef0",
"db_currency_code": "sample string 10"
},
"company_type_id": "02a18554-4189-4dbc-aaf3-fcdccea1f91f",
"company_type_name": "sample string 32",
"company_type": {
"id": "275f5212-8c7d-4440-a25e-7f2be4ed5d4b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "31e1725e-e847-42e2-89b2-3a9008770e75",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3e61c03a-9a64-44c8-ba93-8db1f89725b2",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d393f007-69db-4a97-a507-a505b7030ed1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4902eb76-c99d-4e1d-b048-5a33257db78b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b3d9252d-5588-4044-9138-a93186476afa",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-14T03:58:51.3487018+00:00"
},
"company_sector_id": "fffb6409-78f7-4d6b-b248-6b7484451366",
"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": "207d19fb-0f64-4730-a4cf-77fe69d6d390",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "28bf8a25-02ae-420b-827d-7c46d66ecf8b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "591b16af-ca37-4c9c-8c04-e7458407501b",
"account_manager_user_code": "sample string 56",
"company_status_id": "9feb1539-28aa-415f-9360-d9e251607feb",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-14T03:58:51.3487018+00:00",
"id2": 60
},
"db_language_id": "e68e4f5b-f3e3-492c-a714-91ae2fa52660",
"db_language_code": "sample string 7",
"db_title_id": "b105377e-e797-47dc-8b15-5aa92497f244",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-14T03:58:51.3487018+00:00",
"create_date": "2026-07-14T03:58:51.3487018+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-14T03:58:51.3487018+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.