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": "f21eab89-aca5-4e16-a5ee-44223bf2e0f5",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "31dd863e-fbb7-448f-8415-37f0c119dcc5",
"company_code": "sample string 5",
"company": {
"id": "c56499b0-7035-4066-b315-e3e41510deeb",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-18T03:05:44.701401+00:00",
"sales_territory_id": "90fa9bc5-aadf-4abc-94a9-849b6e7e84ef",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ce890c40-a4a5-468b-8a7c-d22a9489e818",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "080bfbcf-9994-4747-a9db-b42a6d677c29",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3e5a5f50-b906-4caa-b7f9-18142fc96e2a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a12fad1-cf6a-4f9f-ab3f-6cbcd8fa0438",
"db_currency_id": "ae500a18-0efe-40c0-be68-dc56f69ee4b8",
"db_language_id": "280366e7-1cfc-49c1-9165-96a39335cd30",
"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-12-18T03:05:44.701401+00:00"
},
"modified_dateutc": "2025-12-18T03:05:44.701401+00:00"
},
"marketing_segment_id": "0b75922e-b0eb-49aa-9454-0908b97f8bc8",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c26438b0-fcb0-44e2-9593-64733f044431",
"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": "7953c67d-b0be-4385-8d8e-34acb3159456",
"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": "ac87e4e5-3625-4e5d-86ec-edfa4b7b9caf",
"db_country_code": "sample string 28",
"feelist_id": "27302404-032a-44df-ad22-3ffdd7d50ef3",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5924dc9a-1aae-4559-94c2-6dcc84a2f73f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a838137d-cb03-42ce-a7be-a2a05bbee917",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-18T03:05:44.701401+00:00",
"db_currency_id": "67519539-fd56-4dc1-b39e-d03678d4f7c5",
"db_currency_code": "sample string 10"
},
"company_type_id": "cc283a0f-b302-4c64-9504-4f2531617ab1",
"company_type_name": "sample string 32",
"company_type": {
"id": "3761e09f-f19f-4298-818d-1dbea9d19cfa",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2e801622-c857-4b3f-9bca-bb050b75747c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "14dec96b-676f-43cf-92bb-8d16b0e0ad52",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "95cd3066-9477-4c4c-88e2-dde4dda3652b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "77b0283a-91ee-4280-9c6a-9b1826f47b5c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2011e367-76c7-4150-b2ee-9d7665c2612a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-18T03:05:44.701401+00:00"
},
"company_sector_id": "5c39e474-89cf-4a24-ae4c-27ef0bd4686a",
"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": "044d2f06-779c-4e2e-bce7-4658c19ecaba",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "80d52817-deaf-45aa-8ba5-18a238f5eb2a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8a54613a-bc7a-45e1-8ed3-2717fd2fac7a",
"account_manager_user_code": "sample string 56",
"company_status_id": "c8c265f8-87ab-43fa-a8b7-8b03bd38f59a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-18T03:05:44.701401+00:00",
"id2": 60
},
"db_language_id": "b187fefc-a18b-44a9-be5c-a99c060602be",
"db_language_code": "sample string 7",
"db_title_id": "4d159aa8-be63-4cec-841a-1d0b61dc67a1",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-18T03:05:44.701401+00:00",
"create_date": "2025-12-18T03:05:44.701401+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-12-18T03:05:44.701401+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.