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": "c52c96b9-31cd-42fd-a6d0-28f9beb36568",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c1951c8f-8c42-4911-b97d-444f7dae6cd2",
"company_code": "sample string 5",
"company": {
"id": "574215a7-88d4-40d0-ae53-e68cc83f0aae",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-02T22:23:46.0655143+00:00",
"sales_territory_id": "5ced5805-6d97-4c42-b943-ada6e6271846",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "3c5865c2-dc3a-479e-99fd-979ff268936f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7e0337ba-25a0-4dde-8f64-a07287a257f2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "adf1d277-f55c-4f05-abe5-041ad59df468",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fe962031-28c3-47cb-bf90-ff73e3887d18",
"db_currency_id": "5d25e289-0940-4710-a047-bb7e447aabf5",
"db_language_id": "43b4162e-dd41-40e9-8e5b-cd1409aa632e",
"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-02T22:23:46.0655143+00:00"
},
"modified_dateutc": "2026-08-02T22:23:46.0655143+00:00"
},
"marketing_segment_id": "be34c9f9-21d3-419f-ae18-f1fdb9773975",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "acb5641e-6b65-4137-b891-cd66af00a639",
"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": "2f63b027-9750-4e51-8213-e39604622fda",
"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": "d7134bbb-9797-4580-af04-ac1e10e79b02",
"db_country_code": "sample string 28",
"feelist_id": "95b836bc-bd71-4c18-8820-1cb38c860ffc",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "cd8cba4a-f8f2-4545-a949-982a77fcb132",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "48cd98ab-cb80-4503-979a-5c61296ad064",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-02T22:23:46.0655143+00:00",
"db_currency_id": "f32c8dee-d006-4fd8-8010-582a62dbe943",
"db_currency_code": "sample string 10"
},
"company_type_id": "0888579c-f208-4b59-a435-788603d04643",
"company_type_name": "sample string 32",
"company_type": {
"id": "3dc0f9fe-a786-4df5-8237-1ed655114f6c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "86e49fd7-cf1d-444b-8161-b259ddd1a541",
"sales_organization_code": "sample string 5"
},
"db_language_id": "20b1e80b-a57a-407f-a2e2-a3d90ba5b005",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0a8d18b6-fd36-465b-af00-17c60e74f092",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "9b66c2c9-5369-45d3-b055-5754c6fbc158",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "36a636ab-92cb-446d-bc7a-22ae59dfeb97",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-02T22:23:46.0655143+00:00"
},
"company_sector_id": "521df26b-1366-4073-8b13-3421d2fbb783",
"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": "502fc7ff-1bec-4ef4-8982-402d21a1b402",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f74f4470-890e-4ebf-88a4-3d8715417581",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ae64b97d-0f36-40b1-b02f-0367f7543212",
"account_manager_user_code": "sample string 56",
"company_status_id": "58a293d6-ee64-4f77-93f3-01aa94747cdd",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-02T22:23:46.0655143+00:00",
"id2": 60
},
"db_language_id": "7b954f07-c74e-41ca-a957-ad2c7e4bfd9d",
"db_language_code": "sample string 7",
"db_title_id": "ee25a4d4-4efc-4cef-91d6-a850167fd7a8",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-02T22:23:46.0655143+00:00",
"create_date": "2026-08-02T22:23:46.0655143+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-02T22:23:46.0655143+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.