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": "65c21262-3cc3-41eb-a187-b480841d7b48",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "9b4353d6-7726-4657-a937-cdf80eb9d2c4",
"company_code": "sample string 5",
"company": {
"id": "6ac6b4f1-4b1d-4fb2-9260-a65029a8f769",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-06-07T22:56:15.7639172+00:00",
"sales_territory_id": "3b906106-1773-4b73-b122-9045a6fe7255",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "dd71a816-31d6-409e-9a1a-68731d04d9f5",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f8712bad-04b0-4a86-a60f-705811062d65",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f3ade949-7c5c-4ed9-b8e0-60108781e655",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4441f9aa-35a0-4b16-a6d7-64f830d627e7",
"db_currency_id": "34fd27d2-2a3d-4f52-9562-c59d1c9a7d68",
"db_language_id": "9a57c65b-c4f8-4eba-9e4c-2b5cf3fdcf6e",
"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-06-07T22:56:15.7639172+00:00"
},
"modified_dateutc": "2025-06-07T22:56:15.7639172+00:00"
},
"marketing_segment_id": "d1ea52f4-cbf7-4f58-878f-a4ac67f22245",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c9b7ebee-4481-44e1-8aa5-60c0f8bd31e1",
"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": "18b71e55-d1d4-45f5-9bcd-d6635c2f6a56",
"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": "e3d335c8-6b6a-4383-9826-7c9cd165eaa8",
"db_country_code": "sample string 28",
"feelist_id": "0bad7d49-6df6-4242-9347-89de2a96ab69",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d6a73187-a842-400c-9cdf-09d179d066d1",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c6e137fc-30a9-43f9-88b4-2fd12bf5520b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-06-07T22:56:15.7639172+00:00",
"db_currency_id": "27005e9b-b24a-472e-aae0-26cbda0454a1",
"db_currency_code": "sample string 10"
},
"company_type_id": "8be1ebe9-656d-4054-b38d-351f30f51612",
"company_type_name": "sample string 32",
"company_type": {
"id": "f0c5b8cb-5f27-4617-a272-d3e34e243c6a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a75dd715-fae5-43d2-bbff-c2030d8b8118",
"sales_organization_code": "sample string 5"
},
"db_language_id": "cd5790c3-247c-4218-ba21-0dbd6a7b9831",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5000729f-efe0-4a23-88c2-f7a62e271120",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f2b124e9-d65e-4f40-9872-6bb92f07f08d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "12fde240-fc3d-450d-aa25-f32cafe13b7f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-06-07T22:56:15.7639172+00:00"
},
"company_sector_id": "3257e9f9-efaa-48bb-b225-268d8ddaafcb",
"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": "a7b93e3f-5ac5-43ef-af31-25d20a1b7b1b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9820d0f0-57ac-4328-bdf0-dc0d0b90d54d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "6594b629-e1eb-45d3-a750-fcb39a4fbb4f",
"account_manager_user_code": "sample string 56",
"company_status_id": "bb84db8b-23d2-41ad-8c92-da169ad78d49",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-06-07T22:56:15.7639172+00:00",
"id2": 60
},
"db_language_id": "fddfbc0d-3899-49b9-868c-c9e5356c1647",
"db_language_code": "sample string 7",
"db_title_id": "85eeea5c-d414-4649-a7d9-78323c9415c4",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-06-07T22:56:15.7639172+00:00",
"create_date": "2025-06-07T22:56:15.7639172+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-06-07T22:56:15.7639172+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.