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": "5c7b3f1f-561c-4f85-a51f-428d25a538a2",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ea521f13-e7d2-497f-aa48-3683e77cc2d8",
"company_code": "sample string 5",
"company": {
"id": "86c96c00-6fda-4297-98a4-bfc7f024b7fa",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-07-04T01:35:57.8832544+00:00",
"sales_territory_id": "2bca0051-e958-4c2f-93f9-60ad9e32d8c3",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "058e69be-a6f6-4b72-afb1-06310f629312",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "58fe21cd-356c-40a1-8cf6-79f27296da59",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "414b3c99-6215-4540-90b5-5a4f7319925e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a64be954-f599-46f1-b40c-4214cd90f0a2",
"db_currency_id": "2844bf93-7c70-4f16-a442-91609cc25e6e",
"db_language_id": "8b4e2a57-0bf2-4071-922a-ac563916b20d",
"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-07-04T01:35:57.8832544+00:00"
},
"modified_dateutc": "2025-07-04T01:35:57.8832544+00:00"
},
"marketing_segment_id": "97d82f1b-aced-4a3e-af7b-b4835a937bda",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "76419060-a5ef-43ce-8768-59a3bbd871dd",
"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": "8eeaa89d-e8b3-4d9e-85b8-dd91feb1aab1",
"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": "2bb37605-f2c1-426c-8155-010943a8e4a0",
"db_country_code": "sample string 28",
"feelist_id": "5299b1fc-5df9-4f58-8f61-75c6efb945e0",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1a5c7d38-8e18-4768-accc-d67c9d399223",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "50e0481c-8e37-499a-96bc-491031ae4184",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-07-04T01:35:57.8832544+00:00",
"db_currency_id": "9178feb9-50d9-4cc5-9be3-8ec8a1cb7215",
"db_currency_code": "sample string 10"
},
"company_type_id": "ba7c3645-fd23-43bf-9422-3116be950e79",
"company_type_name": "sample string 32",
"company_type": {
"id": "7cf99d31-4cd8-44d0-ab46-310c5f3f3824",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "dfa420c1-ec0f-4c36-b253-36b995a7aafe",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b5a11a16-bf0b-4f7d-bc45-6047ee6362b8",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d8d64292-22cf-4b47-a92a-5e098f928aef",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "429b675b-920e-46d8-b8b6-e615b112be64",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d8e79720-ff7f-41a8-a773-e4d549aab193",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-07-04T01:35:57.8832544+00:00"
},
"company_sector_id": "a85e9001-4a27-4eda-b54d-6ba006ce0123",
"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": "fdd95ec3-4987-4705-9f6f-2d02b3a5376c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c37b06ad-083e-490a-9a63-1efbd7cb6b4b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3712c2d6-fb41-4ef0-bfb1-64c3bc058c11",
"account_manager_user_code": "sample string 56",
"company_status_id": "ea71979b-6e70-48af-88e9-4b4a9b7f820a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-07-04T01:35:57.8832544+00:00",
"id2": 60
},
"db_language_id": "90549d0d-68e5-4ffb-a6b9-60e853df0140",
"db_language_code": "sample string 7",
"db_title_id": "62a4763f-23a6-4372-83ee-7f79a31891a5",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-07-04T01:35:57.8832544+00:00",
"create_date": "2025-07-04T01:35:57.8832544+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-07-04T01:35:57.8832544+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.