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": "f59f6445-9f8d-42de-8559-ce4d9df09086",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e70becdc-1ab9-42ff-a706-73d5ccdc4f16",
"company_code": "sample string 5",
"company": {
"id": "f97167f1-898c-4bae-b72c-6976e6737f27",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-26T06:30:22.0149522+00:00",
"sales_territory_id": "6ef00ff9-5ea9-48d8-b0bd-309b5b06d07d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0ca7eb86-706d-4b31-9661-0c636f85f9d7",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2a8877be-3ef2-4201-9b33-96a02f8f174e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d9525991-e284-4d3b-b5d9-a80cd8efaed8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1ecd1a05-703e-47eb-a760-0aed3d4c6d72",
"db_currency_id": "c46d0a8c-d3ae-4538-b7da-2145bacb8ab8",
"db_language_id": "9725f8e8-006d-49fb-becc-55e72c96cfea",
"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-11-26T06:30:22.0149522+00:00"
},
"modified_dateutc": "2025-11-26T06:30:22.0149522+00:00"
},
"marketing_segment_id": "5d75d8f3-18cf-4eb7-a898-4afe15c22c3f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e0f78f6d-c080-44ed-ba5a-0b43f0a03966",
"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": "91eee9f2-0361-4282-9816-439d66883661",
"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": "148d7457-7e08-44fb-aa5c-593e303382f0",
"db_country_code": "sample string 28",
"feelist_id": "fd35c72d-5dde-4d64-99bf-d6aa0e7ea0fb",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "933c26ec-233b-4085-9eef-8f3c5232421a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "9a70de68-8a5d-48e1-bb16-d89b06a74668",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-26T06:30:22.0149522+00:00",
"db_currency_id": "5b144935-8290-4441-a411-3985e0d57525",
"db_currency_code": "sample string 10"
},
"company_type_id": "d4813aef-eb3d-4941-b009-09569aadbd60",
"company_type_name": "sample string 32",
"company_type": {
"id": "cec6ec31-19a0-4ec7-b525-adb09d1b83b8",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "44ef802c-aa66-4bfc-9d90-665850e11a16",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3d0f3fe8-ae5c-4ef2-9d8d-a88374ffd1c0",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a981daf2-2f46-4772-be5c-0cf233807d83",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "93adaade-be31-4380-b341-635d141a8ad9",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e41721d7-3d83-41f3-9680-f045d3316d28",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-26T06:30:22.0149522+00:00"
},
"company_sector_id": "a5445573-edf5-40a6-9ebd-2649bd1bafe9",
"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": "c544246c-d33c-4bf6-9715-1da091bad1ef",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5a0a9725-b3aa-46ae-b830-8ce6fed90d60",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b0455203-84ff-4d73-8e7d-aafdbcb2459e",
"account_manager_user_code": "sample string 56",
"company_status_id": "d625fedf-ef89-4b95-80ae-73d4a64bb16e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-26T06:30:22.0149522+00:00",
"id2": 60
},
"db_language_id": "0b5148a3-1d7a-4771-a0e3-955eeaf78ae1",
"db_language_code": "sample string 7",
"db_title_id": "57aab177-064e-4901-9d87-5f773cd7bcf5",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-26T06:30:22.0149522+00:00",
"create_date": "2025-11-26T06:30:22.0149522+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-11-26T06:30:22.0149522+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.