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": "e8b3f673-7739-4d64-8033-c939a38487d4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "bc9e9169-4e8d-4a7a-97d8-04e4f912003f",
"company_code": "sample string 5",
"company": {
"id": "21065bc3-8758-48f0-add1-fb25a4fc8b4d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-14T05:40:04.9560745+00:00",
"sales_territory_id": "cb2b6508-23e7-4266-84cd-ef2847950689",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9a5ca7cc-65f6-4a77-99d2-c818210179bb",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d472be5f-0c18-4fef-b388-89294cd2dd93",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a80160f4-090d-462d-ab73-833b5c859c6a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4b34c5fb-2926-4818-b6f9-5b899b7ac58d",
"db_currency_id": "880411d3-7e06-4999-ba6c-248529a23e2a",
"db_language_id": "4784e91c-9819-43bd-ad96-cb9cd55fc376",
"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-14T05:40:04.9560745+00:00"
},
"modified_dateutc": "2025-12-14T05:40:04.9560745+00:00"
},
"marketing_segment_id": "825aec10-7f2d-47e3-b9cd-60806cdd25b7",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4c7edb1b-addd-4426-ad6a-c9984842c7a2",
"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": "f3134d49-c318-4728-959a-272caf74d41a",
"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": "0644fda9-9c00-45a4-bd4d-be72b000ae58",
"db_country_code": "sample string 28",
"feelist_id": "0b9837b1-cb64-43ad-af47-7d04109e625a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d161735f-bdfd-4787-ac48-0254034def1e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "032aea45-e902-49e4-8dd7-bf782bc4799d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-14T05:40:04.9560745+00:00",
"db_currency_id": "9089a348-65b9-40bd-bb9d-66710aa2bd5a",
"db_currency_code": "sample string 10"
},
"company_type_id": "5754f0c6-8781-4b1c-9ff7-1df61152ecfb",
"company_type_name": "sample string 32",
"company_type": {
"id": "e7b1ab43-c5b8-4935-a63a-6f98281abd8c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c91b005e-e3f3-40ca-9596-0197c3fedbd5",
"sales_organization_code": "sample string 5"
},
"db_language_id": "296be48e-6088-471f-a8cb-caa7fb8d9694",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5b54d40a-ff02-4954-91da-f5e211273d85",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a7b5170b-47b2-4848-9eab-cd188f98bb6e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "053d9533-7867-419a-b087-e8f815bc531e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-14T05:40:04.9560745+00:00"
},
"company_sector_id": "b98bf869-57c0-4021-b095-26a6284e04bc",
"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": "28236d43-2ced-401f-b4ad-88f268e65963",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "295923c0-16fe-4c06-acb4-bf671b396e02",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8070f9a1-2332-4046-b88e-074f47863cc0",
"account_manager_user_code": "sample string 56",
"company_status_id": "51866969-e62b-48ee-86ff-87c85d977052",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-14T05:40:04.9560745+00:00",
"id2": 60
},
"db_language_id": "9906bae8-8ba0-4b70-a20f-9c61163debfe",
"db_language_code": "sample string 7",
"db_title_id": "30fe84d9-2f94-4b25-b9b8-7b22ac6faffe",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-14T05:40:04.9560745+00:00",
"create_date": "2025-12-14T05:40:04.9560745+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-14T05:40:04.9560745+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.