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": "969472c3-abd3-47fc-9c05-57d348f1538c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a90a41d4-0b1e-443b-acbe-f2a9056f926a",
"company_code": "sample string 5",
"company": {
"id": "d200b9f7-ce4f-479e-9ab2-6ffee577bbd5",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-12T16:17:39.1737347+00:00",
"sales_territory_id": "87cbba78-ab9d-460a-bf0c-a94576c52e5b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "374a97c1-66e8-4b0f-8e2b-0736cb69fb32",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "10e804dc-8d2c-4581-9456-f216147abce8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9a27086c-b2da-4f62-9fdb-e17f3560ef70",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e5206e13-c6a7-40f6-9ce0-e9c77920d051",
"db_currency_id": "28a40f67-f75f-4252-837b-478e90e46be9",
"db_language_id": "7a97aa79-455c-4726-98a8-7e51bd355531",
"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-11-12T16:17:39.1737347+00:00"
},
"modified_dateutc": "2026-11-12T16:17:39.1737347+00:00"
},
"marketing_segment_id": "3c89afab-0e67-403a-8e6d-f426bebeb3c0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ef27267f-8f1f-4283-be94-f85de257dd61",
"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": "33904fb3-a470-44fd-9ef8-f83040740eb5",
"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": "595f728b-34db-4c72-8247-3254c6c45b3d",
"db_country_code": "sample string 28",
"feelist_id": "a953ce78-c040-4fe5-810a-28d2d0fe3e01",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e6076521-f4e8-45f4-aa17-518a2b1d50a5",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2b5bdb14-72d6-4398-b175-3dfa36641cc2",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-12T16:17:39.209629+00:00",
"db_currency_id": "402f1cd8-76dc-473e-871a-cf1a905b023b",
"db_currency_code": "sample string 10"
},
"company_type_id": "bc0e8076-babf-4fa2-b64a-79fb8fdd804d",
"company_type_name": "sample string 32",
"company_type": {
"id": "44b8b8f0-dac2-46f7-8b87-2e7c489bf538",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "179e4712-afae-41a0-b85c-85cc63acd923",
"sales_organization_code": "sample string 5"
},
"db_language_id": "94712e59-03e5-4d7f-b94d-1a0e0a4e4893",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8201f3bf-b843-4c90-b88c-2006ea230261",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "2000f8d6-8524-4efc-9ed9-b7cc2c1fec24",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "593ce853-7049-4682-a281-3984af3e489a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-12T16:17:39.209629+00:00"
},
"company_sector_id": "75511286-cdaa-4915-a659-b3f7ab981275",
"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": "f8b6224f-7d8a-49ca-9373-b85a9cb9d632",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7619be9e-483f-44bd-a687-9029c885903d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "998aba78-8f84-4869-8c44-a129a0eafb4b",
"account_manager_user_code": "sample string 56",
"company_status_id": "a6350546-40cf-4c30-bc47-4f5024b20b73",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-12T16:17:39.209629+00:00",
"id2": 60
},
"db_language_id": "82017b7d-315b-4d49-9196-60607e0c06fa",
"db_language_code": "sample string 7",
"db_title_id": "317e20de-1536-4ee2-a582-33a9bb3dec26",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-12T16:17:39.209629+00:00",
"create_date": "2026-11-12T16:17:39.209629+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-11-12T16:17:39.209629+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.