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": "f3dede49-4598-4593-9af3-2437f7f67745",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "60521476-f611-484b-b6bc-957b3cb7d98c",
"company_code": "sample string 5",
"company": {
"id": "572ce616-5cd5-4076-a177-776005750df4",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-29T08:38:04.4558726+00:00",
"sales_territory_id": "ccef5dd3-14cf-4958-bbd4-219ef48a65b2",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "de684469-32b7-47bd-b2f5-af3ad1fd8495",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c7b8a85f-a24d-40b4-9b35-156c2463d4d5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e0d8a9f0-3ffa-4b22-8359-6387a9ddc5a3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cb6948a5-1696-485c-bc4e-3404e75eae91",
"db_currency_id": "a5b97c50-fe58-41a2-acb2-3c0120d63224",
"db_language_id": "7c29749a-08af-4710-b3c9-6ac140cbcb71",
"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-10-29T08:38:04.4714822+00:00"
},
"modified_dateutc": "2026-10-29T08:38:04.4714822+00:00"
},
"marketing_segment_id": "d13a1325-2724-47b7-871f-f51339066c5b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d0cdf05b-0595-45e8-b2b4-26bb88bc29e5",
"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": "1f69a984-dd17-4fe1-aaec-a26416ea1f67",
"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": "dace19ba-350f-4003-a758-2183161549a3",
"db_country_code": "sample string 28",
"feelist_id": "ca82af3a-48fb-40d0-9cfd-6047a2ab8e36",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "bd8883d6-6df9-487f-9299-41468c30a876",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d983e3e2-6fe5-4a00-9fcd-04c6ed0ece98",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-29T08:38:04.4714822+00:00",
"db_currency_id": "6e7635b6-a85e-4172-b484-954f7b6a5b40",
"db_currency_code": "sample string 10"
},
"company_type_id": "d37516b5-5da2-4f64-a681-759a6d92a805",
"company_type_name": "sample string 32",
"company_type": {
"id": "12b69850-44d4-4334-b59f-07da66d1fc4d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1c050e3b-b044-4700-8c96-4ecd4e3a3e92",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0b906db0-705c-4ac1-849c-528441fc9b3a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0a06222b-2785-4d8c-b38e-0f5e4b269d28",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1a686440-b5a1-42f9-b356-6048bb8c0ef2",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9dd4320d-324e-418e-9092-522612873f2e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-29T08:38:04.4714822+00:00"
},
"company_sector_id": "012f5e21-4b95-48b9-bf48-349475f9b4f6",
"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": "ec9097c8-a00e-4111-8022-2fa6fb095f61",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "6583a8cb-913b-4a8c-a2ec-93d023bc23bb",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "151ddf6e-46d9-44a1-9030-e6bdbf0ffed5",
"account_manager_user_code": "sample string 56",
"company_status_id": "df2d6053-f5c3-443a-b9c0-9c780506c364",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-29T08:38:04.4714822+00:00",
"id2": 60
},
"db_language_id": "afd7fcdb-de8e-4d92-ade3-067abf3ca47f",
"db_language_code": "sample string 7",
"db_title_id": "a83e7b6b-66c5-4e06-8c31-24d2b11df100",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-29T08:38:04.4714822+00:00",
"create_date": "2026-10-29T08:38:04.4714822+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-10-29T08:38:04.4714822+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.