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": "470df336-0fc9-475c-8185-978780e0f289", "firstname": "sample string 2", "lastname": "sample string 3", "company_id": "5101f25a-65de-4060-9ae7-3675da04ff05", "company_code": "sample string 5", "company": { "id": "d6d4d5f6-e641-43ac-9af2-de282d1b4835", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2025-07-19T00:03:36.0025772+00:00", "sales_territory_id": "6031ac9a-12d4-4fee-8f19-f0926f997da6", "sales_territory_code": "sample string 9", "sales_territory": { "id": "8379059d-c2f8-46dd-b575-cfd8955d41c9", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "ac60045f-71a5-4ada-bfee-80f6eb037323", "sales_organization_code": "sample string 5", "sales_organization": { "id": "65e1dc4b-e5fe-4d2e-be76-1cab1ec7a11a", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8b3bd381-ff6a-4978-b8c8-c634edb10765", "db_currency_id": "304032cc-e11f-4b6d-9e59-cc7edb5fff3b", "db_language_id": "ab684e3f-f9f9-4905-b9dd-7b69325aaa04", "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-19T00:03:36.0025772+00:00" }, "modified_dateutc": "2025-07-19T00:03:36.0025772+00:00" }, "marketing_segment_id": "34b31a79-bb85-4437-9750-a2508d32a6af", "marketing_segment_code": "sample string 11", "sales_organization_id": "9af74254-2c2b-4e44-88da-e07ba6092345", "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": "7f040673-1350-4d14-8122-dde8541b5dba", "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": "b62150d7-3405-4e2d-8940-1a5486e9a84d", "db_country_code": "sample string 28", "feelist_id": "8983a43b-5a10-47fa-9fa4-9c27c17bdcd5", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "952b2cb0-326c-47f5-8405-065dda2a5a5b", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "b4f30e72-2ff3-4584-9852-7335929ca9e5", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2025-07-19T00:03:36.0181989+00:00", "db_currency_id": "0d630893-63e9-45eb-82c2-1d8f938c74ae", "db_currency_code": "sample string 10" }, "company_type_id": "e227d760-d258-4c9a-931e-dac4bb8ac367", "company_type_name": "sample string 32", "company_type": { "id": "f6d8682a-6d48-4cee-8ee8-7a3ffb26ed46", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "a85e9284-806f-4c1a-aa58-6432f8514872", "sales_organization_code": "sample string 5" }, "db_language_id": "0377a185-805e-495a-a5d5-a783468ea15a", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "b422d421-1491-4ecb-924e-e3bf84818ca4", "article_price_label_code": "sample string 37", "db_payment_method_id": "0cb28912-9b33-4270-bdeb-d8acb26cf263", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "015d1666-1eb5-4e2b-8307-89203128e9c6", "name": "sample string 2", "description": "sample string 3", "reference_back_office": "sample string 4", "activated": true, "modified_dateutc": "2025-07-19T00:03:36.0181989+00:00" }, "company_sector_id": "fa35132c-64ee-4743-a697-a16f0183646e", "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": "26ced0d4-ee3a-4b02-a7ac-2b141d7ffefa", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "b0d47a62-cf25-4046-a8e8-0324b3eb665d", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "4ef3decb-4f35-43f8-890f-16da15b9b20d", "account_manager_user_code": "sample string 56", "company_status_id": "28eed7d2-369c-4506-b7fd-8f573aa218e2", "invoice_email_to": "sample string 58", "modified_dateutc": "2025-07-19T00:03:36.0181989+00:00", "id2": 60 }, "db_language_id": "f0e0ef07-c792-4ac5-ba6b-bbc56fbca5e0", "db_language_code": "sample string 7", "db_title_id": "0485b2b2-2b90-4c0e-b7ac-06fd42384bc1", "archived": true, "functions": "sample string 10", "e_login": "sample string 11", "e_password": "sample string 12", "notes": "sample string 13", "birthdate": "2025-07-19T00:03:36.0181989+00:00", "create_date": "2025-07-19T00:03:36.0181989+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-19T00:03:36.0181989+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.