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": "b53566b0-f648-4bfc-9216-1203b9a0a0e5",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "de1ad506-7429-4e37-9af5-38545d4e2f76",
"company_code": "sample string 5",
"company": {
"id": "7152e2d1-87cc-4370-92bd-e837c278158f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-04-04T02:55:08.0609637+00:00",
"sales_territory_id": "200e8b52-6159-45e0-83ba-8169005c2720",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5f09397a-8a33-4807-8a29-21a8adbc01a3",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4b742ca1-ed7a-4317-a9ac-23cbf902d2e6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9479cb82-1fd9-4e15-b2a9-611274820900",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "28879d84-5ca7-47d2-9f6a-eeb0774859bb",
"db_currency_id": "12c9cceb-50e2-405b-8e39-b53ee53caa92",
"db_language_id": "b68ae242-5e2e-461a-925d-95d181da10d0",
"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": "2025-04-04T02:55:08.0765857+00:00"
},
"modified_dateutc": "2025-04-04T02:55:08.0765857+00:00"
},
"marketing_segment_id": "68f50bb3-4225-4b04-a795-cf4dc43a2d43",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6bc93be6-be55-4ce4-ba66-e99450142115",
"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": "7d6453e3-194a-444a-9400-ce47e546df91",
"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": "f015b92e-08bc-480d-9bf0-a198a6ae56a6",
"db_country_code": "sample string 28",
"feelist_id": "f748fdf9-f413-4353-b5fa-73150aecd4b8",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e52ab738-7af8-4a24-910f-e0ab2c6bf4be",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e7c21b29-0795-46f6-82fa-c3f1b580d8e3",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-04-04T02:55:08.0765857+00:00",
"db_currency_id": "b6de25df-1227-438c-b071-0ba61c3e3cec",
"db_currency_code": "sample string 10"
},
"company_type_id": "733f2515-f954-4933-8614-bdc41914488c",
"company_type_name": "sample string 32",
"company_type": {
"id": "2065fb2c-e876-401e-9cf3-c18cc4848261",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "02978bf1-bfbf-473f-98d8-5dba0863c818",
"sales_organization_code": "sample string 5"
},
"db_language_id": "92678ac5-6635-4cc5-a95e-9c86769022c5",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9e46a8c3-efe3-4ed0-a268-3ede5a4a2d6a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "eff5e430-ff3a-42d5-8b71-17302dd5a16b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ce829db0-0a38-46d5-b5c8-b709157be850",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-04-04T02:55:08.0765857+00:00"
},
"company_sector_id": "59e0d37a-acee-4048-8d83-60dcd6e33723",
"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": "5dca2462-cf4a-4629-bd19-a1854c82f4f0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "6534feb1-13d6-4aaa-a0c9-5a383f605189",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "66c48797-7f43-46ad-aac2-67a89e03435f",
"account_manager_user_code": "sample string 56",
"company_status_id": "52a0fcc6-f70e-4bcf-ac4d-8d78865b6c2c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-04-04T02:55:08.0765857+00:00",
"id2": 60
},
"db_language_id": "e448c5a1-6060-4244-8215-43a3aa2d5e7e",
"db_language_code": "sample string 7",
"db_title_id": "3000d022-3149-4e8c-be1e-2d8be04fbd87",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-04-04T02:55:08.0765857+00:00",
"create_date": "2025-04-04T02:55:08.0765857+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": "2025-04-04T02:55:08.0765857+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.