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": "d9f14ca3-b34c-4586-9341-621b550a40ae",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "9b83ce4e-acdb-406a-b7b8-d883378981f2",
"company_code": "sample string 5",
"company": {
"id": "767c707c-e786-4688-907f-d8c10a842921",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-30T12:57:18.7768974+00:00",
"sales_territory_id": "aa97f222-af34-468c-93a2-fd214670bb33",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f37d267a-5c33-403c-b93c-dfdabb577c2e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0fe21562-d8d6-49dd-b247-f480312c8bb5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b5dba48c-db10-4a24-9755-9685617ddc88",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fd7bb5f4-f0f3-43b1-b228-2af8b57e5bb4",
"db_currency_id": "82701978-8b05-4282-bed6-c3f681f32d10",
"db_language_id": "f9d1fd85-c056-4afe-b1f2-505d2d3d9472",
"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-30T12:57:18.7768974+00:00"
},
"modified_dateutc": "2026-08-30T12:57:18.7768974+00:00"
},
"marketing_segment_id": "13d7df2a-e90a-449a-8096-ec8ff3badb17",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "db6b7811-550a-417a-9afd-e18d7c973d1c",
"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": "d2ebc2b2-57a1-4174-8cdb-69f3eea35aa9",
"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": "1de5e7e5-55f0-4166-9d81-895df221b7b0",
"db_country_code": "sample string 28",
"feelist_id": "3ad0bb52-3878-4abb-9019-95ebd4f8670b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "31f80630-fce5-4289-bc40-e933bb30b4f6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "129ac51a-992e-4920-8a99-1d56f3ee114d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-30T12:57:18.7768974+00:00",
"db_currency_id": "34d3d08b-1118-4189-b55c-bcddf131b511",
"db_currency_code": "sample string 10"
},
"company_type_id": "ffaf72c7-ea1f-4ed5-b25c-58cc80c9fcbf",
"company_type_name": "sample string 32",
"company_type": {
"id": "9cb14152-1bf1-489d-b196-473d5765346f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ee14b24e-155d-4511-8754-8597461cd5e3",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2bab6d2a-d100-4f4b-aca8-7d3ee98b63cd",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e792dbef-7e93-4248-bdc6-8272fba4bb0e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "35d4c4a0-d7a4-4d00-bd5a-879a08e9b0d4",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0b869eb4-9e26-42bb-9f3a-eb4681e08995",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-30T12:57:18.7768974+00:00"
},
"company_sector_id": "eb02278f-3d7f-4b42-9ae8-a0d53f366e64",
"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": "5b49b8f2-a8d5-4576-bd98-d99bc1e951af",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "89960587-f361-4ef2-8072-2b370a18f783",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a56c1790-9162-45fa-b8fd-1fb965a4e520",
"account_manager_user_code": "sample string 56",
"company_status_id": "b12a6385-82c7-4400-acc8-8f52a6b06c3e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-30T12:57:18.7768974+00:00",
"id2": 60
},
"db_language_id": "3df9c98a-e01e-4863-8d72-9417863c5424",
"db_language_code": "sample string 7",
"db_title_id": "3cc40c9a-4054-4219-a7f4-42dac7a6a60e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-30T12:57:18.7768974+00:00",
"create_date": "2026-08-30T12:57:18.7768974+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-30T12:57:18.7768974+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.