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": "6dd700f0-76b5-4031-b077-8651c63d19b1",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "9519cc34-099e-4423-9c70-af35fc840842",
"company_code": "sample string 5",
"company": {
"id": "76c85972-5603-4eaf-80ee-ce98cc2149e8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-10T06:17:36.622974+00:00",
"sales_territory_id": "6c97ce65-ec89-4e93-830f-8d2c60799b91",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "dc3a04b3-eade-4736-a2ee-f1dc86ef30f7",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "583d2cc1-74da-4b21-aba2-fc7182598f98",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8416236a-a212-4849-b100-0a18464c3a2a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "23aafdde-7591-44e7-84ab-165fe626ed53",
"db_currency_id": "52d36145-0d11-4c8d-ac3a-6ac2732242ab",
"db_language_id": "d390b445-5dfb-4b92-b1cd-bc2fbe2dc075",
"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-09-10T06:17:36.622974+00:00"
},
"modified_dateutc": "2026-09-10T06:17:36.622974+00:00"
},
"marketing_segment_id": "224c0f93-9662-46cd-8365-54a340a68cdc",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e08408ee-1cb7-4804-9c57-d00a9c2634e8",
"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": "53c0f825-65b5-4e6b-97ef-b83a6882610a",
"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": "bf0a5211-c23e-4305-bb29-e2550b087024",
"db_country_code": "sample string 28",
"feelist_id": "9514fbdc-a251-4998-907d-13114e636b5a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1b41b5e9-0378-4500-93db-9601db1e9a01",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c2b17b65-e84b-47c6-8229-c583fef4d418",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-10T06:17:36.622974+00:00",
"db_currency_id": "0a51eb0f-53ea-4844-9af1-679f1d01049a",
"db_currency_code": "sample string 10"
},
"company_type_id": "406a7f91-a802-44b5-98f5-4ae887911c6b",
"company_type_name": "sample string 32",
"company_type": {
"id": "1554822a-c1b1-4d4e-9d9a-0a1817eb3386",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "30a5de7a-33ec-4775-b229-7ec42aad1c6d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7f81fb65-c768-47cb-934c-48803b47168b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "844835e9-05ff-41b0-afb7-58acd4693926",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a5ec6e9f-d966-449e-a2bf-40c4f8d197dd",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "fbb0a630-d5d1-46b7-929e-24d6d93d24d3",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-10T06:17:36.622974+00:00"
},
"company_sector_id": "223ce1a8-cf9b-47d7-8179-0d7952e764b6",
"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": "462a0e82-2ee5-4dae-839b-fb1bcbd62cd9",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e1ad707c-2f45-484c-b1fd-813f00ba1033",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "233d5dad-da89-4af8-9dfc-3648f12ea2d7",
"account_manager_user_code": "sample string 56",
"company_status_id": "77a908d5-640d-4614-b234-13bfeeebce7b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-10T06:17:36.622974+00:00",
"id2": 60
},
"db_language_id": "8b96ddd4-7a9d-4dd3-8b96-e1e1cb9b3fb2",
"db_language_code": "sample string 7",
"db_title_id": "82b9ed37-665a-494c-a48e-9bb7efde23fa",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-10T06:17:36.622974+00:00",
"create_date": "2026-09-10T06:17:36.622974+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-09-10T06:17:36.622974+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.