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": "13823cb2-371d-4be1-89ed-9612cf01bd62",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4baab71d-ebba-4c02-8582-9f19bf148138",
"company_code": "sample string 5",
"company": {
"id": "dc2b0bac-d671-4315-aacb-b9b8e122f6d6",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-02T01:43:43.5919069+00:00",
"sales_territory_id": "189a3cab-6962-4546-ac97-95d099555cd2",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8941586f-56fa-4cfd-ad57-bb550a7a55d9",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "29830c28-258f-47b8-ab5e-00eface9eab0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d58548d2-e686-40d0-911e-ee3f5ac1b5ba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e89398cf-24ed-459c-b776-8add5eddfa9b",
"db_currency_id": "3bdc968c-dbb9-41b3-b310-8af6528e08c5",
"db_language_id": "0351d5ce-0efa-451d-a644-6689d80fec69",
"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-09-02T01:43:43.5919069+00:00"
},
"modified_dateutc": "2026-09-02T01:43:43.5919069+00:00"
},
"marketing_segment_id": "3962cf51-3d54-47d2-a7fc-05a19a93b7af",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b3a7e893-f6e2-4a37-81ab-7d38f158a111",
"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": "bcb70397-27c3-408e-825a-06a8e0f555b8",
"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": "eca683fd-74e3-4142-a9ea-acafd3b7768f",
"db_country_code": "sample string 28",
"feelist_id": "1e204543-0a03-4f98-9b70-a773db085f66",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4affdf14-dee6-4d74-a3fb-fba66499765e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "66a81732-44e3-4c3e-97e6-d2765d0491dc",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-02T01:43:43.5919069+00:00",
"db_currency_id": "8daa40fd-2889-4490-b58a-d2b28a0ff04a",
"db_currency_code": "sample string 10"
},
"company_type_id": "dce70ce2-b55a-45cc-9c0f-87be8e58a9e7",
"company_type_name": "sample string 32",
"company_type": {
"id": "94877fb1-1620-48a6-a3e6-6450bd0cef47",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ff49bc10-acb3-4564-8835-9e7281dca8a8",
"sales_organization_code": "sample string 5"
},
"db_language_id": "01d1a0c4-5985-42c8-9d64-aea78b2c72ea",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a30464d6-56b4-4c82-8204-6869cfe3f76c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "42c54d13-6baa-4809-ba61-240bff26a84e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "17b0da2a-988b-4217-9188-9519b453b6c8",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-02T01:43:43.5919069+00:00"
},
"company_sector_id": "acfbfba9-e3b7-43b3-91ad-62e1f803af0c",
"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": "e0ef1b6f-b2d6-4ac6-92a8-0696bbe3a6c3",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "57eb827b-84a2-4f2f-bd1f-11e4cb204ed1",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "300332fd-777b-441e-8f4a-6ca66dd6f1ba",
"account_manager_user_code": "sample string 56",
"company_status_id": "c8f050c5-81c7-4787-b9f7-1e6b2ffce141",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-02T01:43:43.5919069+00:00",
"id2": 60
},
"db_language_id": "04a14de0-c778-46a2-b828-660b4b35f866",
"db_language_code": "sample string 7",
"db_title_id": "2508f0ad-cf8f-4fd9-8f00-4b10df695ffe",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-02T01:43:43.5919069+00:00",
"create_date": "2026-09-02T01:43:43.5919069+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-09-02T01:43:43.5919069+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.