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": "a03159b3-cc92-4e09-a52f-b6dfe57a3722",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "5ccff5be-c5d5-47dc-9067-b213ebc3f83e",
"company_code": "sample string 5",
"company": {
"id": "7b99ea60-767b-4661-8c66-78168547d4c6",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-02T22:30:04.437835+00:00",
"sales_territory_id": "2abf8ad1-9fe9-4b90-a0fc-f416af55da8d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1116efd7-bc55-47c6-857a-98a11d31ba4e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "99bfd621-0c76-4c17-9d0a-7a914a528cd4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a7cf7f62-0952-4443-a2ad-7f007f6ffbfa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "71f9a931-f4b0-4bec-a82d-e38732270a4e",
"db_currency_id": "e56ee40f-27b1-4ab2-92ab-a405f6abfcfe",
"db_language_id": "ea3f964b-42d5-4b55-b117-f80f10a1c17f",
"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-12-02T22:30:04.437835+00:00"
},
"modified_dateutc": "2025-12-02T22:30:04.437835+00:00"
},
"marketing_segment_id": "31367aa9-e734-4164-8fa2-d9f8a3d86627",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ff9b8270-8a2e-4261-8958-5faa4ca6e590",
"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": "ea7e2ed8-fd96-4e45-8eee-923d54f4b8f7",
"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": "01b05344-a88a-4956-9227-222d6c13188f",
"db_country_code": "sample string 28",
"feelist_id": "5158dd82-7589-48c7-9f7b-7b110c002243",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d57abe8d-cb88-495c-8c0a-61e2bd67cbb7",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "650daf66-ee03-4927-a3f0-86fd09bff6b5",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-02T22:30:04.437835+00:00",
"db_currency_id": "3ee94a7c-7e27-4f83-be54-5efac35d3cd9",
"db_currency_code": "sample string 10"
},
"company_type_id": "d5dd9891-36a6-4931-a38a-16df3392c73b",
"company_type_name": "sample string 32",
"company_type": {
"id": "f90fbb8f-bf7b-40e9-ad93-9ce190313936",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "72fe0f3a-1f83-4b1d-a1d1-bc1908a68c54",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0b53fdb3-cc5b-4d3d-a9ff-e1251a35c3d7",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0d2a7d13-95e9-4171-b1df-474310139034",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "9e867257-b27c-4d67-9169-d1861998a3b2",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "6f953875-cfd3-445c-83ab-9514dae93492",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-02T22:30:04.437835+00:00"
},
"company_sector_id": "1d264133-f6ca-4657-87e1-5af7672adc39",
"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": "ea77ccdc-0b22-46fb-ab89-89937a91b449",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0289b1f0-578b-478e-9361-9ac9ed19c3c1",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d5835248-146c-465a-8142-9bf353ad7ad7",
"account_manager_user_code": "sample string 56",
"company_status_id": "4ab51224-bd97-4f18-95f8-58bb15509827",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-02T22:30:04.437835+00:00",
"id2": 60
},
"db_language_id": "bc49e2b8-efcd-473b-b06e-627d3e033bd8",
"db_language_code": "sample string 7",
"db_title_id": "fbae4c3d-24cc-4bb1-9711-68eb0e8ce0fb",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-02T22:30:04.437835+00:00",
"create_date": "2025-12-02T22:30:04.437835+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-12-02T22:30:04.437835+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.