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": "7ab6a2dc-a963-44b4-862c-93c2c726321f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "88c9a945-6689-47c0-8ce6-7e17f105db97",
"company_code": "sample string 5",
"company": {
"id": "1c422b2b-1790-4632-ab71-c3e511c4a00b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-05-28T01:07:57.5279197+00:00",
"sales_territory_id": "dd6b0fa7-5854-42b7-94d5-ad99c1ec7946",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "55d8997c-4684-4ba0-85f7-c141627874e5",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "53554edb-4b6c-459b-abda-06033510f20c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "30686faf-1afc-418b-921f-7d7afa7bda29",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73f2ba43-948c-4cc8-8764-7bc539c45262",
"db_currency_id": "47ae52b5-61fb-4710-96ab-420356fbf7db",
"db_language_id": "b791a330-fd3a-4420-a6ed-75abc0dce075",
"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-05-28T01:07:57.5279197+00:00"
},
"modified_dateutc": "2025-05-28T01:07:57.5279197+00:00"
},
"marketing_segment_id": "ac6f3259-28fa-4693-a7ff-dd9b7930e8d6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7611e5b4-360f-4274-ad99-2f2f1c58e87d",
"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": "d423bbb7-9164-434b-98c0-995fe285e93f",
"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": "f8b0a1d0-3ad4-4055-996e-c1f96be4dd88",
"db_country_code": "sample string 28",
"feelist_id": "28e33ac3-c5b7-4de6-9027-64a69432f05d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b06311d6-80ba-4b47-adf1-432870c469a4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8c3e0ae8-36f7-4969-896c-249043d4f1c7",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-05-28T01:07:57.5279197+00:00",
"db_currency_id": "0fba8caa-f57d-4ebe-ad74-af7f6b5d1d33",
"db_currency_code": "sample string 10"
},
"company_type_id": "c105b0c1-b412-42b8-8264-b87166e186c5",
"company_type_name": "sample string 32",
"company_type": {
"id": "e29ce417-8f08-4b21-8b74-0cc3bc3542e5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "826934b8-90bb-410e-a4cf-eeb497117056",
"sales_organization_code": "sample string 5"
},
"db_language_id": "403f4420-9f97-4b4e-a44b-0b47723e5a8c",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f3e7572b-cd79-4852-b607-e5fa9037aa69",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1718f9ac-f525-418c-b455-9a65465166c7",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a93ecc07-56f3-4c8b-90da-a99ab6fbf8e8",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-05-28T01:07:57.5279197+00:00"
},
"company_sector_id": "ceb55371-a685-47c8-bac3-8e28cd444317",
"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": "6ae940a1-ff09-4651-9072-1ddeb7ad89e9",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2a1e3d0a-92a4-4537-b492-dd2ec7a4b2ba",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "33635087-ba77-463f-88a3-8c3807e0a747",
"account_manager_user_code": "sample string 56",
"company_status_id": "bccbbda9-866a-456a-9349-d3f520e6a68b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-05-28T01:07:57.5279197+00:00",
"id2": 60
},
"db_language_id": "9efb060d-4b16-4b02-a891-10690d28627b",
"db_language_code": "sample string 7",
"db_title_id": "9cca5669-6ce4-4b90-a0fe-38aedb8fdceb",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-05-28T01:07:57.5279197+00:00",
"create_date": "2025-05-28T01:07:57.5279197+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-05-28T01:07:57.5279197+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.