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": "83b609b3-321e-42fe-a202-d0b527dd9702",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2736c66c-f613-4e1c-b75c-39c9d659467d",
"company_code": "sample string 5",
"company": {
"id": "59b3d1ea-9606-4020-9e0c-ae8251ded178",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-21T11:25:01.3944051+00:00",
"sales_territory_id": "358134de-6e76-4ab6-92ee-b568e0edcee3",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "10439b1f-e8cf-4132-8f91-98069b90c748",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cae0677a-9e46-4d36-b066-5f6407b68084",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6188b750-46ac-43ea-a2ce-658684491c49",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63af4b6f-c695-4c11-8035-8b9fa9bbe904",
"db_currency_id": "20af68b8-dfa4-4e56-b8cc-53570d4af7ae",
"db_language_id": "d683d1e5-10bf-436b-ae86-e2ddcaab406f",
"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": "2026-05-21T11:25:01.3944051+00:00"
},
"modified_dateutc": "2026-05-21T11:25:01.3944051+00:00"
},
"marketing_segment_id": "61dfd124-b1f0-4aa0-bc5f-cde6f17b59b4",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ea0a0638-7c67-41f3-bfdb-52e2624f7553",
"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": "d56f9e83-0f1a-45d3-b38e-186b86ec8eb6",
"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": "fb3093cd-35f8-4624-916b-3354b98e78af",
"db_country_code": "sample string 28",
"feelist_id": "208ad23f-9e33-4606-a0c9-619b46dc7a8e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c515aefc-be90-4499-ac0d-bc86fa591e94",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b218eb6f-d4ec-437f-b07d-bbf462965386",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-21T11:25:01.3944051+00:00",
"db_currency_id": "2dc32ca4-f742-4fc2-877e-702c5124995d",
"db_currency_code": "sample string 10"
},
"company_type_id": "794f6558-2157-4cad-8002-888ecf478e22",
"company_type_name": "sample string 32",
"company_type": {
"id": "9f201650-682e-4f1e-b98e-9c83ba112900",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5a785220-5421-4600-96c0-19fdedd89565",
"sales_organization_code": "sample string 5"
},
"db_language_id": "886130e5-af31-4432-a1a7-0dd21ae282c6",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "439ebeee-98e5-4638-a2f2-e9a632a8ef50",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "9164d46f-0208-4146-853b-df83ced54cfb",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "17a59cab-15bf-4f06-ae0f-626480e5ee60",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-21T11:25:01.3944051+00:00"
},
"company_sector_id": "7464e24a-6bfd-4332-9f19-24ddaaf2c84c",
"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": "1eb088d0-951b-489b-930d-82c6ae7ca4d2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "49e04f91-ebae-449e-86fb-355db85b9105",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "1787537d-1066-46eb-8cb2-a3b733d84fce",
"account_manager_user_code": "sample string 56",
"company_status_id": "33d38f11-7335-49b7-b188-b6e0b7fcceb2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-21T11:25:01.3944051+00:00",
"id2": 60
},
"db_language_id": "509fe233-fc10-43ba-a47f-c4bdf5f07db5",
"db_language_code": "sample string 7",
"db_title_id": "e391fd4c-5b87-4dcd-aad0-fdd4f1a632be",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-21T11:25:01.3944051+00:00",
"create_date": "2026-05-21T11:25:01.3944051+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": "2026-05-21T11:25:01.3944051+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.