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": "36cc45b5-2d1f-4696-8a65-41d67e76db16",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "35e3be3f-3832-45bd-92f5-dfcf73573959",
"company_code": "sample string 5",
"company": {
"id": "91f22e56-8380-4237-b063-3a73f64a6f43",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-23T09:28:52.7611828+00:00",
"sales_territory_id": "4cefbc1b-c443-4a72-874f-f65aad3bcdec",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8dba95a3-1747-4c6b-acfc-85a99ee54a36",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a80773ac-8eae-43a9-a5d5-7b5978950448",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "059acf12-008b-4e80-93df-66b98795b1ae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f389874d-2b46-4387-83b1-132dc4f685c3",
"db_currency_id": "6ea06abb-3bb0-4692-a4dc-e3b56f5bf30c",
"db_language_id": "5a993c10-adf8-4722-9178-093ee839cf87",
"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-23T09:28:52.7611828+00:00"
},
"modified_dateutc": "2026-08-23T09:28:52.7611828+00:00"
},
"marketing_segment_id": "37bbe1b5-53ca-4972-b105-8652daa35dea",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6fe0939a-472e-4810-ba1a-96d237d22459",
"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": "f6d3a8d9-e887-4301-9224-ee05b19e1e50",
"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": "80e0cef5-edc2-406a-a30e-1338140c0c83",
"db_country_code": "sample string 28",
"feelist_id": "19c6b657-9491-4c22-a00a-2c4d7d979285",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d05d3d19-4b3c-4041-8868-5059a01909e8",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e874fe4b-2ac2-4a6d-b142-bebfdb12a604",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-23T09:28:52.7611828+00:00",
"db_currency_id": "a59b00c5-1770-4809-8a35-29a87b6a82cb",
"db_currency_code": "sample string 10"
},
"company_type_id": "7244c6da-fd01-4d99-a5e6-0d71946ccf4d",
"company_type_name": "sample string 32",
"company_type": {
"id": "e9aac132-1277-4be9-a8a7-7c8ecd3f5ab6",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "240fd614-c818-433a-a0c6-a2f4f2207d11",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d44e9b62-58ef-4adf-8d32-71f8d2073f16",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0653c5b8-c257-4326-90d1-b6c15e1f2393",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "80508d43-c4db-4290-ba46-e97ffe7283f9",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "db86b26c-3578-43b8-9c1c-65989f2c823c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-23T09:28:52.7611828+00:00"
},
"company_sector_id": "fb772042-28cf-4f3b-9de2-138ca9457bd2",
"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": "da42ca76-7a58-4a22-aec0-199c0296fd67",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d66f627b-751d-4ade-9dea-8bddfc47aa64",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0f0825e4-4451-41d6-9673-32d46a41d019",
"account_manager_user_code": "sample string 56",
"company_status_id": "4ca6d32a-df7d-491e-a3d3-bc8da65874a5",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-23T09:28:52.7611828+00:00",
"id2": 60
},
"db_language_id": "32f6aac6-057d-42b5-82a3-f280314247f1",
"db_language_code": "sample string 7",
"db_title_id": "3462f0ae-9977-43cf-8a2e-5b083f35f338",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-23T09:28:52.7611828+00:00",
"create_date": "2026-08-23T09:28:52.7611828+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-23T09:28:52.7611828+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.