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": "0cf7456a-82f3-4da5-ab0e-ac3d9f02f6c5", "firstname": "sample string 2", "lastname": "sample string 3", "company_id": "a7160d30-a92a-4e2b-aad3-442532e5eb2d", "company_code": "sample string 5", "company": { "id": "d068e816-9c81-4aa0-b7d7-07f2955fe20a", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2025-01-17T08:18:27.9307194+00:00", "sales_territory_id": "77cf19e7-f43b-41a2-aab3-65cb6f074c18", "sales_territory_code": "sample string 9", "sales_territory": { "id": "5a99a109-3302-4c0e-8f83-a58103017b11", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "bceae862-a258-4251-9e4c-a3010db7689e", "sales_organization_code": "sample string 5", "sales_organization": { "id": "dc7fe179-5803-4888-a2aa-70c4e8c4b9b8", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "148efb83-8efc-48da-9c3d-1dd54384f422", "db_currency_id": "db6d8994-f876-4716-b84a-3e70ce78c299", "db_language_id": "7440c172-e81c-49e9-a10d-b821f35f1794", "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-01-17T08:18:27.9307194+00:00" }, "modified_dateutc": "2025-01-17T08:18:27.9307194+00:00" }, "marketing_segment_id": "f5154064-0388-4215-a155-6f04d3770a03", "marketing_segment_code": "sample string 11", "sales_organization_id": "d7e449ef-373f-453e-a326-0cd5bdd93cf0", "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": "2204b369-1760-4f46-bd42-3b3e23bc7483", "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": "67f78cff-a0b8-4d5c-993f-aad46294ac9f", "db_country_code": "sample string 28", "feelist_id": "55c6cc74-059e-4531-b042-e707318eb768", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "7f111d7d-34aa-4fd1-a838-88eeeea7fe30", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "340a3bee-c679-46d0-80f6-be981446c3e2", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2025-01-17T08:18:27.9307194+00:00", "db_currency_id": "e85a9ea9-b63e-4171-beef-c70e413a4bfb", "db_currency_code": "sample string 10" }, "company_type_id": "77d4260b-5978-4021-aeed-6c2a9ed404f3", "company_type_name": "sample string 32", "company_type": { "id": "01cced61-0860-429c-82e7-32306e1e5cb6", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "188a6030-2c56-424d-b07c-fc1c5ab071d6", "sales_organization_code": "sample string 5" }, "db_language_id": "9c536cd6-da56-4425-bcdd-ab6265169c7a", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "8ea7a4cf-2099-4a1c-bacd-6122ba946648", "article_price_label_code": "sample string 37", "db_payment_method_id": "60db35e8-795e-4482-a44b-0630fc6c4bb8", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "4a77a58b-18de-4096-bb40-2940ae9b67c8", "name": "sample string 2", "description": "sample string 3", "reference_back_office": "sample string 4", "activated": true, "modified_dateutc": "2025-01-17T08:18:27.9307194+00:00" }, "company_sector_id": "2debfee6-fbe5-4e0f-98a8-9ebe39d58cca", "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": "c3995d9f-dfb7-4019-8bb1-556045ca6868", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "dbf1567f-378f-432a-8317-5bd134e4635d", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "384132ef-a45b-453b-913d-b7ebf19476f1", "account_manager_user_code": "sample string 56", "company_status_id": "e9edb743-585c-45f5-b464-9ead88e726fb", "invoice_email_to": "sample string 58", "modified_dateutc": "2025-01-17T08:18:27.9307194+00:00", "id2": 60 }, "db_language_id": "f06cdfde-dc26-44dd-a9c0-b8ece054921c", "db_language_code": "sample string 7", "db_title_id": "a7de7a6f-4b0f-42fd-b3d8-0f43dc76e88b", "archived": true, "functions": "sample string 10", "e_login": "sample string 11", "e_password": "sample string 12", "notes": "sample string 13", "birthdate": "2025-01-17T08:18:27.9307194+00:00", "create_date": "2025-01-17T08:18:27.9307194+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-01-17T08:18:27.9307194+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.