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": "1dece3a5-6ce9-4764-9a73-cb4d06090c35", "firstname": "sample string 2", "lastname": "sample string 3", "company_id": "df0ce25c-fbf5-427a-a3f7-a1383d597fac", "company_code": "sample string 5", "company": { "id": "2ec9fb6d-7c71-45e9-8cad-d631805181a2", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2025-02-19T08:31:59.104508+00:00", "sales_territory_id": "756bdfdb-c002-4bdd-a098-ebb757880e42", "sales_territory_code": "sample string 9", "sales_territory": { "id": "79c183e3-af15-4fee-aca0-9e5ab6141a28", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "d9a9840b-5420-4f5b-a18e-08a47bc208d9", "sales_organization_code": "sample string 5", "sales_organization": { "id": "e8035ade-3068-4c36-9c20-1d835eb7546f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "f09ecb6b-1524-4f11-a744-8b763ec6f9d2", "db_currency_id": "83578ae7-e92e-446d-966c-316938e9f18c", "db_language_id": "7f780c85-20c6-4dd4-9d3a-51e48eb005c1", "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-02-19T08:31:59.104508+00:00" }, "modified_dateutc": "2025-02-19T08:31:59.104508+00:00" }, "marketing_segment_id": "18b9b497-e4a3-41cd-8e94-34cac9332c2a", "marketing_segment_code": "sample string 11", "sales_organization_id": "d0228af3-80fd-45af-8cdc-011d7f425d2e", "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": "45139fab-aed3-433c-8c90-e5df0f07380a", "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": "1de32190-0964-43b4-a23b-3574df46dcfa", "db_country_code": "sample string 28", "feelist_id": "b9f2baa3-d780-44da-a708-1d0fbd1a5612", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "4cd88019-7968-4977-9e2d-2a4e89197230", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "e9a0fab8-e4cf-45e2-81f3-5991488c29e9", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2025-02-19T08:31:59.104508+00:00", "db_currency_id": "0e545a26-d083-4fa0-8b68-db068fa60682", "db_currency_code": "sample string 10" }, "company_type_id": "8f5e516b-b732-4d42-969f-6f3213296aa7", "company_type_name": "sample string 32", "company_type": { "id": "2db92f60-c1d1-42dd-890e-0be319d8316b", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "d53c2184-5937-44ae-82ef-2dc21fd9d124", "sales_organization_code": "sample string 5" }, "db_language_id": "20e4986a-eeea-4b2b-8fec-69a1e5f8da42", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "a361d654-88d7-4395-ad6d-2584de8cc0fd", "article_price_label_code": "sample string 37", "db_payment_method_id": "1703e8bb-a1de-4f21-b0dd-98c1839b6fcf", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "e8dc9e9f-396e-49b9-a4fe-7823ca07e39d", "name": "sample string 2", "description": "sample string 3", "reference_back_office": "sample string 4", "activated": true, "modified_dateutc": "2025-02-19T08:31:59.104508+00:00" }, "company_sector_id": "4f035c64-0c55-496d-a76e-54bb7edf7587", "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": "2da6d882-5e7d-4e97-b555-6ed183c6e2a3", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "88ee8d48-1e4e-4ba9-8027-8d0143bcfd8c", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "4ccf1c15-9cae-4311-8a77-d13dddec7422", "account_manager_user_code": "sample string 56", "company_status_id": "e12aba2d-0b6a-45c1-93e9-b4894e44a909", "invoice_email_to": "sample string 58", "modified_dateutc": "2025-02-19T08:31:59.104508+00:00", "id2": 60 }, "db_language_id": "c12ef402-39e3-43ce-a578-6d25ccdee6e8", "db_language_code": "sample string 7", "db_title_id": "e04dafdf-a002-4e69-a32b-c382d33ac51a", "archived": true, "functions": "sample string 10", "e_login": "sample string 11", "e_password": "sample string 12", "notes": "sample string 13", "birthdate": "2025-02-19T08:31:59.104508+00:00", "create_date": "2025-02-19T08:31:59.104508+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-02-19T08:31:59.104508+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.