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": "18ff85ae-9ee3-423e-b5df-e459bea74b63",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "cbea0c7c-369d-47e3-8dc1-eab2d72498d2",
"company_code": "sample string 5",
"company": {
"id": "d4d8e28b-7a45-45c9-a585-417b881ce8ac",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-28T13:10:48.8171333+00:00",
"sales_territory_id": "e08c02a9-ad69-4671-8202-0963debeb17c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "cfeae759-1faf-4711-b96a-80a2cf4b1ce2",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "84fe90e7-b0d6-4e76-a6c6-1a8d512f55e3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "81fd7a5b-35c3-4a3e-a16d-d774344ff94a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d3c207c7-359b-4192-b8fa-14a2b6140b5b",
"db_currency_id": "3b0d3e7e-d66c-4ce0-96f0-3ee424e907ad",
"db_language_id": "4ec72962-69b8-4bce-92d1-ffe9578688e3",
"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-28T13:10:48.8171333+00:00"
},
"modified_dateutc": "2026-01-28T13:10:48.8171333+00:00"
},
"marketing_segment_id": "157c2920-3369-4038-966f-9c8bef34bd10",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e5d8b7b0-08d3-474b-811b-a66999d99b8f",
"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": "21b7371d-dbe7-4927-8c95-214ad2c5deca",
"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": "12d52e4e-f7ae-4d57-a8f7-1cff184a47dc",
"db_country_code": "sample string 28",
"feelist_id": "1847617d-948a-4791-ac77-9e9f9e420493",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8ea25869-7be2-486f-9b34-264931404656",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "cdf8869a-405e-4ffc-b96a-0cc2fc731a82",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-28T13:10:48.8171333+00:00",
"db_currency_id": "44b12a1b-fe82-48f7-b8a3-2500de66ce9f",
"db_currency_code": "sample string 10"
},
"company_type_id": "6d4f8c77-3c04-4e55-b1f7-1fce4809e4dc",
"company_type_name": "sample string 32",
"company_type": {
"id": "263e2c23-5e47-4966-b820-cceabaaa6996",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cac343cb-08db-47f2-ab31-2f6f9a38b69d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9851e868-5012-4e5a-a0ec-4481685a9e5e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "354f678c-7481-4117-8ae9-a59aa2fc3aa6",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f1b43a75-6a1b-47fc-96ae-2e36e6b2c789",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "110e2d39-2bc9-4841-a838-8aa0b3abae4b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-28T13:10:48.8171333+00:00"
},
"company_sector_id": "d48de182-af12-4996-83f6-1b4ef6b8904c",
"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": "4541dcec-90c3-48c4-bf2e-e6ba97e74e6d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "76036b37-5e8d-449c-aadb-bccb1ff08571",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4123abdc-2a8f-4ced-9363-fd9b0a18e99d",
"account_manager_user_code": "sample string 56",
"company_status_id": "3cc586ff-423f-49a2-8562-158c91a47eef",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-28T13:10:48.8171333+00:00",
"id2": 60
},
"db_language_id": "be84e723-14c8-4e23-9eba-ecca0e769183",
"db_language_code": "sample string 7",
"db_title_id": "a9063d56-f05d-4aaf-b75d-ebacd4014e18",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-28T13:10:48.8171333+00:00",
"create_date": "2026-01-28T13:10:48.8171333+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-28T13:10:48.8171333+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.