Creates a new contact object
Request Information
URI Parameters :
None.
Body Parameters :
contactName | 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
{ "id": "38d5c5d0-2b83-4820-9992-afb4e52a6665", "firstname": "sample string 2", "lastname": "sample string 3", "company_id": "e8c82599-e584-4f42-adde-8dc11775efd9", "company_code": "sample string 5", "company": { "id": "89e07591-52f5-47e4-8720-d56680775ae0", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2025-07-12T03:56:02.2163202+00:00", "sales_territory_id": "7db85983-ef12-4e40-b09d-75ec7748a06b", "sales_territory_code": "sample string 9", "sales_territory": { "id": "836a344a-6b2f-4235-bba9-fbde4af5016d", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "eb21fb86-cedf-4915-9719-128b7774d2d2", "sales_organization_code": "sample string 5", "sales_organization": { "id": "0f4efa60-ba3d-4f00-8196-f4fd16e8357e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c3d9785a-5e1d-44dd-9b21-e9b315ccfe43", "db_currency_id": "f17af471-dd14-43f6-a0e5-830e99d85cee", "db_language_id": "40de9544-a837-4305-9af5-e200fef28508", "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-07-12T03:56:02.2163202+00:00" }, "modified_dateutc": "2025-07-12T03:56:02.2163202+00:00" }, "marketing_segment_id": "92390819-0c52-4ae5-99c3-7db8968b96d6", "marketing_segment_code": "sample string 11", "sales_organization_id": "b0051264-d881-42a8-842c-4f161d777c38", "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": "a96e6e8f-0f34-4a4c-8df5-37cc54349edd", "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": "4872967a-9cda-48a0-8f3f-974b89c954eb", "db_country_code": "sample string 28", "feelist_id": "c474c6fc-7a33-4ccb-afc8-8e70d051a59f", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "af06990e-236a-43ea-98e0-7606ca6b50ac", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "a4300bbc-9b8b-4e6a-bb6d-98d151a51b8f", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2025-07-12T03:56:02.2163202+00:00", "db_currency_id": "9ac93d77-1a1b-46f6-8b5d-b18ce418c40f", "db_currency_code": "sample string 10" }, "company_type_id": "470b3b8b-1b7e-4ad9-8103-910a128ec1e9", "company_type_name": "sample string 32", "company_type": { "id": "6ec42cda-37e1-4eef-81c2-25fab4d4a484", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "fa57963b-02ea-4b4e-a270-7a88165ce8d0", "sales_organization_code": "sample string 5" }, "db_language_id": "e64c3ceb-bd57-40a1-a798-6a4fc946178d", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "550e4778-222d-45be-8d97-ad36f15084d9", "article_price_label_code": "sample string 37", "db_payment_method_id": "5fd69c7e-3216-43aa-bcfe-28e9e7bd32d0", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "620c26c7-c988-4628-b7be-71bb192c2a53", "name": "sample string 2", "description": "sample string 3", "reference_back_office": "sample string 4", "activated": true, "modified_dateutc": "2025-07-12T03:56:02.2163202+00:00" }, "company_sector_id": "9a2960c9-eaab-4224-8c09-9f50da022884", "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": "551d3794-6905-4354-9080-f9890366b1c1", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "4fef0a35-13ec-4905-a48d-7c132796f4c6", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "5f6087ae-7b4c-4336-afab-64288771630d", "account_manager_user_code": "sample string 56", "company_status_id": "4d4988b9-fdd8-4757-b4f4-dd8ecc4fe935", "invoice_email_to": "sample string 58", "modified_dateutc": "2025-07-12T03:56:02.2163202+00:00", "id2": 60 }, "db_language_id": "2ebe3f7a-0438-4b82-b854-37f880b9d068", "db_language_code": "sample string 7", "db_title_id": "52a560b3-272f-458e-b8b3-fe09599dedd2", "archived": true, "functions": "sample string 10", "e_login": "sample string 11", "e_password": "sample string 12", "notes": "sample string 13", "birthdate": "2025-07-12T03:56:02.2163202+00:00", "create_date": "2025-07-12T03:56:02.2163202+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-07-12T03:56:02.2163202+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.