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": "3b654a17-46be-439d-a195-aa25b214c1f7",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d0391a68-3a77-4cda-91de-a7310db9088d",
"company_code": "sample string 5",
"company": {
"id": "5aedcecf-263c-4ff2-8390-9b58506e00a9",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-09T00:59:43.2508026+00:00",
"sales_territory_id": "eb1e2aa9-2c1f-4b33-b277-3366a774c255",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9a06a862-3c70-46ca-b7a5-70fbfd52468c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "027bc423-350e-4733-aa14-d3e3430200ee",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1a977a44-731a-4faa-a937-bfe47592faa9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "44cf061c-918d-4d4e-a2a8-676891cc4f37",
"db_currency_id": "1a8d0a25-9a8e-479b-811a-a89e1068332b",
"db_language_id": "027e91ae-6de3-498b-a42b-fbbbf3907160",
"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-06-09T00:59:43.2508026+00:00"
},
"modified_dateutc": "2026-06-09T00:59:43.2508026+00:00"
},
"marketing_segment_id": "517f6363-d2bf-409a-9d2c-234da2d6b65f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c315d3f6-2146-4480-b275-0d0e32a7d629",
"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": "9deae66b-da42-4dee-b1f4-f2fbf06352ff",
"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": "fe21b64f-0437-4527-8808-652ebc1c394e",
"db_country_code": "sample string 28",
"feelist_id": "6b7cb8c7-30d8-4094-bce0-d3786bc218c9",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "40d2d499-b02a-45f0-a1e4-6379fb40d9a2",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8de76b2b-a5f6-41a1-b880-3aee5d7147c4",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-09T00:59:43.2508026+00:00",
"db_currency_id": "8d0c6c62-dd68-4566-8398-ae84c1ebfa8b",
"db_currency_code": "sample string 10"
},
"company_type_id": "03aeb1ec-1cc9-4054-bfcf-b4912f3f90e0",
"company_type_name": "sample string 32",
"company_type": {
"id": "3837a9bb-8592-48dd-8de0-e412cb4ae8d3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b4c5835a-841d-4827-b60e-6d3c31ce9547",
"sales_organization_code": "sample string 5"
},
"db_language_id": "282b86ba-1eb2-4e98-90f7-489534f12116",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "1e971778-0ade-4079-8387-81c9dcc0ae1e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0072a819-cab9-4c1b-8e18-f58aa6326d99",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ac23739e-b55c-4918-ba57-88686092c34d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-09T00:59:43.2508026+00:00"
},
"company_sector_id": "859269df-f3dc-4041-9488-c623cf964e68",
"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": "b8bbb780-9541-4af6-a995-a285ba856b39",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "fcd05a51-6985-493c-b68b-fd7b92292292",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8e6b7f54-8d83-455c-8805-745a12b3d057",
"account_manager_user_code": "sample string 56",
"company_status_id": "a5445c53-7750-4de3-980b-4165b6661138",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-09T00:59:43.2508026+00:00",
"id2": 60
},
"db_language_id": "8bee01ad-dbfc-43b0-9cbf-5243e67c1584",
"db_language_code": "sample string 7",
"db_title_id": "1f34778c-9713-4413-be0c-2c9fd5cbc501",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-09T00:59:43.2508026+00:00",
"create_date": "2026-06-09T00:59:43.2508026+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-06-09T00:59:43.2508026+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.