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": "f638cd26-f975-4a1e-9afe-f642ee01e06d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0e255707-96e8-4cc6-9326-177b38f7557e",
"company_code": "sample string 5",
"company": {
"id": "eef1255b-f3fb-43c5-84bd-fb30971b83ef",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-21T08:42:49.7490833+00:00",
"sales_territory_id": "b61e6a79-4aec-4624-82ea-51c60ce9d9ce",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a0f00bbf-091c-4281-86c9-0937b80468e9",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "83432a27-b23d-438d-b7f1-078894248a2a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f8e1e9e8-7b2a-45be-90d3-a1f693f0f92d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "00da481f-59fc-448a-92a3-9184c17769b0",
"db_currency_id": "d0b7427a-a5bd-4da4-8703-a3e98a5c6bd0",
"db_language_id": "54891247-c672-4540-a831-b9ce18c3c6bf",
"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-11-21T08:42:49.7490833+00:00"
},
"modified_dateutc": "2025-11-21T08:42:49.7490833+00:00"
},
"marketing_segment_id": "98fbe76e-9edf-410e-acf3-18ccd46abe5e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b8061426-7cc9-4ee8-b3a3-0f75a61fa7ee",
"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": "5f3c7fee-545b-4b3f-8af2-b3b0c851d273",
"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": "67970c6e-257a-4e00-9045-e1f6a7c4e791",
"db_country_code": "sample string 28",
"feelist_id": "ff5b0e4c-2993-4877-82db-14f59da3482c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "fa8f1677-4c57-4911-9d2f-5cb27999025d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6b0427e3-7f31-44a2-9cb0-d020f4db9bc9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-21T08:42:49.7490833+00:00",
"db_currency_id": "37542c2a-8c56-4312-8e5c-3c25db29b277",
"db_currency_code": "sample string 10"
},
"company_type_id": "7e5ac9a2-2eee-4787-86dd-28a17d0691d4",
"company_type_name": "sample string 32",
"company_type": {
"id": "f0fa3b29-029d-4c8d-bc80-a1d1ed365310",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c90e6512-0ef0-48ad-80e2-2636fc29d9d2",
"sales_organization_code": "sample string 5"
},
"db_language_id": "04aabfdf-5859-4549-8691-083dfdb04927",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3b433c7d-e1ce-4f84-a214-d325ebf74cf3",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b4079094-dfb3-4197-9542-47e9abec283b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0629a551-5b12-4803-8fdf-438836fd12fe",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-21T08:42:49.7490833+00:00"
},
"company_sector_id": "64fac736-bf73-47bc-81ec-09d731224eb6",
"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": "7a6090d0-a947-4bc1-9b8e-18279c151f0b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "43a611c6-fe15-43ea-9681-8dffd940aa27",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "cce9a570-06a2-4562-86ec-303a8e565208",
"account_manager_user_code": "sample string 56",
"company_status_id": "ff27d694-b243-461c-8c90-5b968aa19e95",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-21T08:42:49.7490833+00:00",
"id2": 60
},
"db_language_id": "8cbfed60-ccff-43b7-9854-ac79929577a4",
"db_language_code": "sample string 7",
"db_title_id": "b64ad059-7a4a-4ffc-89ab-3ef610f9b71c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-21T08:42:49.7490833+00:00",
"create_date": "2025-11-21T08:42:49.7490833+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-11-21T08:42:49.7490833+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.