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": "fb135d7c-82b6-4b67-82a0-2424a493dccc",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "668de409-823f-4b9b-b478-96fe6ed91e9b",
"company_code": "sample string 5",
"company": {
"id": "2f474720-b54f-4955-860d-36a3935671ac",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-30T09:45:21.8423223+00:00",
"sales_territory_id": "75a6f236-c61e-4957-b65e-523675e15b11",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "438c7ddf-d9ee-4c82-8c38-2e6bda9ce2bb",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fb448859-ebef-48db-b86e-86186e209da5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6158c43a-dbcc-407a-a596-df206609d5fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "456d840a-1d3e-4b1f-94f7-141e645a0fa6",
"db_currency_id": "9bc26bcb-eac6-40e5-a863-8c599d81ecc5",
"db_language_id": "aa1794ab-7e63-40b8-b94a-7ff29b1a5432",
"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-05-30T09:45:21.8423223+00:00"
},
"modified_dateutc": "2026-05-30T09:45:21.8423223+00:00"
},
"marketing_segment_id": "8cc0183b-0c05-41a2-973a-ca1c447a96c9",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "45ddeb4e-3f30-4cc8-8d5d-5a91d3f8b16b",
"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": "63f0235d-9fba-402e-a7ca-33560ddc0a15",
"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": "bd0e83e4-e223-49cb-922b-3999e08cbef0",
"db_country_code": "sample string 28",
"feelist_id": "f9ba5af5-b981-4f1a-8838-fb29e925fec1",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f0b8a603-c4c4-44ec-af9d-0206f415e76e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8e2c8429-fc33-4e8a-8761-4bcaa171a661",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-30T09:45:21.8423223+00:00",
"db_currency_id": "2f4f8385-9ecf-43a3-b0c6-e43effc5b1d0",
"db_currency_code": "sample string 10"
},
"company_type_id": "ae69585a-4b40-4287-8e53-aef8b76da619",
"company_type_name": "sample string 32",
"company_type": {
"id": "9efc34a7-7a08-4ef1-845d-5629a4755066",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "59fbbbe8-2e70-4f77-9ae2-de0cd1a1b9d6",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0c725b12-295e-444f-b968-95d85a8eb789",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "69c9d2f5-80e2-4c5d-83cb-ec84cd2e4d13",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a6eb7faa-5862-4a07-9be2-07b84bbd8215",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e0ce7a40-ac62-44f0-b828-b96bbe7ecdbe",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-30T09:45:21.8423223+00:00"
},
"company_sector_id": "0a6908d7-4ce6-4ea7-af73-47ab603796ac",
"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": "2419f8c2-e138-4177-90e9-172ee125fd3a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7feeb980-5242-40b4-9932-207449b7bb1f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "89a9dc01-6686-4c4b-9b90-e28bcd9483c0",
"account_manager_user_code": "sample string 56",
"company_status_id": "3cc42993-4ddb-4a2e-82da-b63d2c70bfb1",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-30T09:45:21.8423223+00:00",
"id2": 60
},
"db_language_id": "20b0b333-88a5-4586-b3f4-e14f38059933",
"db_language_code": "sample string 7",
"db_title_id": "086aadda-69c9-4a09-bcc8-f57385fb0601",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-30T09:45:21.8423223+00:00",
"create_date": "2026-05-30T09:45:21.8423223+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-05-30T09:45:21.8423223+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.