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": "153256bc-203b-46be-aadd-9463f960bd79",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d9a35e7b-54dc-46d7-a67e-159ca3991bf6",
"company_code": "sample string 5",
"company": {
"id": "fbc80b3d-94db-4cf0-aa66-3feb7a2226b2",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-15T23:22:04.1739767+00:00",
"sales_territory_id": "6a3532a9-368d-46d9-acf5-c4997ee42673",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5e665097-86ac-4999-a5b0-011838e9951a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f269d464-0e92-4e2f-ab16-34f8ad7ad38e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bccd7f7b-2251-4d32-82e6-679a231fa4b9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "544b88b4-460b-44bd-bfaf-5ae67e5e3244",
"db_currency_id": "c59f4f99-a26d-4ba4-a1fb-fcee74c3362b",
"db_language_id": "4cb48c0e-4a30-4280-beb3-0c903b0aae64",
"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-09-15T23:22:04.1739767+00:00"
},
"modified_dateutc": "2025-09-15T23:22:04.1739767+00:00"
},
"marketing_segment_id": "f7b638ae-05c1-48ff-b647-0d723587aad3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f663d8f5-8e4d-4c71-88aa-9c61276d15f8",
"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": "e5849207-49b6-45c3-9755-9b5a014d24a2",
"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": "c5330f7f-2978-4a6c-9c66-c20c3da602c9",
"db_country_code": "sample string 28",
"feelist_id": "8671eeb7-6d50-4438-b907-2be769de3b69",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "559019e6-1843-44ef-8d77-d58fbf30015e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c54b63f0-bc0a-49d2-bbf0-699617e2f743",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-15T23:22:04.1739767+00:00",
"db_currency_id": "a2779361-f48e-431c-adbe-590c4fce1530",
"db_currency_code": "sample string 10"
},
"company_type_id": "17151d5d-0509-4032-8e9a-36d04393bc51",
"company_type_name": "sample string 32",
"company_type": {
"id": "72b5a740-7edd-418d-8e47-b021b148c8de",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "66f9fb8a-7f40-4092-b2af-3bf8b6edafa6",
"sales_organization_code": "sample string 5"
},
"db_language_id": "02b77ac7-3e51-48d5-afa7-256761aca3a5",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d7811325-720c-4278-9fcb-3d4678ffe7e4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "24763c28-9d9f-42c1-b290-7cf830a8f97e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3c1d39f3-016a-4e8c-a20e-2750b8224468",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-15T23:22:04.1739767+00:00"
},
"company_sector_id": "8349fd05-a35d-412c-86aa-727b2347e76d",
"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": "bf424598-7e3b-428a-ad3a-8021ea3d85dc",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5602407f-e26a-4bc8-8fd9-8773f959bea7",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "6622369d-0a65-4eca-b41a-e53222244e16",
"account_manager_user_code": "sample string 56",
"company_status_id": "a57c1c57-687e-4138-b290-70d3d0165b24",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-15T23:22:04.1739767+00:00",
"id2": 60
},
"db_language_id": "279790eb-7f7e-42f2-96e3-2582c6e9b28b",
"db_language_code": "sample string 7",
"db_title_id": "40d36713-b7b8-48bd-adba-f725cd355366",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-15T23:22:04.1739767+00:00",
"create_date": "2025-09-15T23:22:04.1739767+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-09-15T23:22:04.1739767+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.