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": "c4331b53-d07c-4300-a3e9-82b3dfa8f6dc",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4816a391-d676-4d00-ac25-8bbb0fe9fe77",
"company_code": "sample string 5",
"company": {
"id": "c4c1646b-260d-4c63-aca7-06e51e46c7dc",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-25T16:59:37.1811774+00:00",
"sales_territory_id": "3b7b5782-adc5-477b-83a0-30f5c2270f16",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "470d791c-4fd5-44a6-bdf5-3e6fb57c884a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c8527723-6b87-4be9-8aac-5b2b55e29b79",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c53efbda-9ee1-4e43-a146-69006719928c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e883e170-63f5-4607-9797-e2ffbf9387f6",
"db_currency_id": "99829a63-ea4b-45bc-a6e7-052269abb46f",
"db_language_id": "38f0107c-aef6-4d02-91b0-523286d7d590",
"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-25T16:59:37.1811774+00:00"
},
"modified_dateutc": "2025-12-25T16:59:37.1811774+00:00"
},
"marketing_segment_id": "31b9b040-d008-4c51-ac4e-b9d38877fbd3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3a78ee2f-5c79-4ccd-9a70-3760f2d7f8a8",
"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": "65f55b91-7a16-4d11-8f2f-2d261afd0570",
"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": "18d13f1d-7ad1-4cc3-9551-86442207afaa",
"db_country_code": "sample string 28",
"feelist_id": "4dd1c1ac-fcfe-49c6-9ba6-383626191709",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3d6af154-ea0e-49ef-86b0-aa4ce5c23e75",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "64bce305-6351-4c6f-97a9-f8803615ee67",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-25T16:59:37.1811774+00:00",
"db_currency_id": "1e318b48-66a4-4f3c-8758-1e44e950592b",
"db_currency_code": "sample string 10"
},
"company_type_id": "d82cc54b-f827-4da9-819b-59b19ed758e3",
"company_type_name": "sample string 32",
"company_type": {
"id": "dce8d5de-dc0f-4263-821f-f4b99e822efd",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "57b2c653-ff6e-446a-8757-228f45189f3b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "096f0b6b-5f58-4fb4-911c-6c4fb63efad1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4aad92e4-3b79-48f7-bdc4-c5908784227f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ef13feaf-278a-46fc-899d-20b9bdbcb21c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "79d2fb75-245f-4cc7-bfa7-4f3e989f46ea",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-25T16:59:37.1811774+00:00"
},
"company_sector_id": "0c2c2c81-b937-4bf6-86cd-1a826fbe24e5",
"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": "a419deff-5eba-4e30-bce0-96689950b99b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "84e7cf00-5bb3-45d8-9bc6-69b6e3b0e3b4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "eb6d9bc0-a745-4b84-8308-6db3c76e1d1a",
"account_manager_user_code": "sample string 56",
"company_status_id": "bf930125-9679-44fe-a32e-7bff66309a3c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-25T16:59:37.1811774+00:00",
"id2": 60
},
"db_language_id": "d389c213-eb23-4d9a-aaaa-be9bd61f3756",
"db_language_code": "sample string 7",
"db_title_id": "7a4c3a64-cea4-4b67-9deb-8a90aa087d6a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-25T16:59:37.1811774+00:00",
"create_date": "2025-12-25T16:59:37.1811774+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-25T16:59:37.1811774+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.