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": "64892c90-9a9d-4277-a8a3-15b7c05054ec",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2af2d5b2-c631-4aa0-9fdd-4d9135b3681a",
"company_code": "sample string 5",
"company": {
"id": "f6ef64d7-18d8-4f5f-8825-ce3ece3b3f83",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-22T13:39:29.710259+00:00",
"sales_territory_id": "5bc6af74-d09b-48fe-9666-9d145efa7818",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "aaa16c4b-c4bd-4611-b93e-665591237a9e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b02eea1c-dfa7-46f8-8683-3f4d0a20b6b7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1c03bf25-09e2-48c8-a32e-896cae34a1fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6d678fb9-3311-4ff6-94da-3114ca26b6ba",
"db_currency_id": "5626553b-1834-42c1-b068-129b3e0941d4",
"db_language_id": "d8d577f2-67d4-4001-a6ed-852b85b405bb",
"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-01-22T13:39:29.710259+00:00"
},
"modified_dateutc": "2026-01-22T13:39:29.710259+00:00"
},
"marketing_segment_id": "2c4a7a5a-5430-484b-957d-74334c27b7b9",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "57c24cc3-b380-4183-bcc9-f84592a2d6d0",
"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": "98a01d04-9191-4dc7-a078-f530f9ec3076",
"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": "5dfbb802-c6fb-473c-a958-8f8dd005aa32",
"db_country_code": "sample string 28",
"feelist_id": "0194ab6c-c6bb-4570-87d7-d9fa6a060a22",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "381243cc-de35-4a7b-8950-1234241c1db4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e762f6af-4d54-4a3b-a896-acd2d1c4474d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-22T13:39:29.710259+00:00",
"db_currency_id": "c2ee8102-7d0f-4777-966e-821cba41a1b2",
"db_currency_code": "sample string 10"
},
"company_type_id": "1dcc8460-ca65-46b3-87f1-507f37579321",
"company_type_name": "sample string 32",
"company_type": {
"id": "583b49cf-95e9-49be-9dc3-71fab8ca5df9",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "83251d9b-3cf5-48cb-97a5-f1627f20eea0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "79eb9fbb-ff33-472e-86f0-3eb5751039bc",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4abc4cc7-0e09-48da-9804-30b572281f2a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "46c6d1b2-c711-4f20-8476-6e7ca8b18956",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0d7beabc-7737-42a9-ad36-e0f27fcfbb5a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-22T13:39:29.7258819+00:00"
},
"company_sector_id": "fc8136b8-d8ec-4117-8cc7-9ad5e9572b2d",
"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": "3a513c20-e897-45cf-9f35-88b8d5fbfa18",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b5274aa1-1e72-49e2-a7b0-27e93865edd5",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "5902f158-4a4f-4c92-97a8-fa0983cf5852",
"account_manager_user_code": "sample string 56",
"company_status_id": "e96b92db-18dc-4e37-868f-c6abd5086d1c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-22T13:39:29.7258819+00:00",
"id2": 60
},
"db_language_id": "3a3174b4-d1dd-4d1d-a3c5-c04805bd0723",
"db_language_code": "sample string 7",
"db_title_id": "c1ec8a36-1896-4146-b14b-2b2dec6ef6fb",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-22T13:39:29.7258819+00:00",
"create_date": "2026-01-22T13:39:29.7258819+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-01-22T13:39:29.7258819+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.