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": "bfc484f4-5be7-405b-a7e6-71deada6fc21",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d4ecfff5-4648-4e1d-be6f-6ce0f182cf66",
"company_code": "sample string 5",
"company": {
"id": "6fc54251-f64d-44b9-b0b1-87ec34f4ceb8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-10T01:04:53.8504926+00:00",
"sales_territory_id": "e930465c-dfbc-4648-be70-6516e7a276f6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7b2b249a-a150-45cf-9a99-5aff8d6c9444",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8d8b6e32-7662-49a1-a854-3886a1dd4da8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "08e4a915-369e-46be-821b-7d9b49df7072",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "34fe57b7-51c7-4efc-acd8-9c0915226150",
"db_currency_id": "fec5ae19-ef0b-4006-ba8b-e4d377adf06d",
"db_language_id": "c0d287a2-f518-4e5e-91fa-d12f5d948420",
"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-04-10T01:04:53.8504926+00:00"
},
"modified_dateutc": "2026-04-10T01:04:53.8504926+00:00"
},
"marketing_segment_id": "70d5889f-3dfb-407a-9fd3-608c65ffbd3a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "82168432-85a0-4aa8-a0f2-5a350a0a4087",
"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": "ad40585f-73a6-49f1-b2f0-492d3b6ce9c0",
"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": "1b2575c0-7cfa-4c03-bea8-8d15354a0ab4",
"db_country_code": "sample string 28",
"feelist_id": "ab1ab88d-8fb0-4886-91dd-dc4d066df1fa",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "bc360b7f-ad48-4750-93f1-87fb8b660092",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "16d8a0ba-40b4-4706-aebe-b166e2e3556c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-10T01:04:53.8504926+00:00",
"db_currency_id": "e373cb2d-6be9-447c-a2fe-850dedf011b7",
"db_currency_code": "sample string 10"
},
"company_type_id": "525ba56c-957e-432f-b9fd-82ffe59ee44b",
"company_type_name": "sample string 32",
"company_type": {
"id": "0cbf7eb3-8b3b-49f1-96e2-06fb506a27cd",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b8712cd3-ba96-4e28-80d0-8ffbcf9d3d88",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e4281141-40a7-4464-b119-1565ece421a0",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "12d3763a-09d6-46d1-95a2-c3d8a99f6bf7",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "44385008-3570-4d18-b0b2-c26cf4ffcc30",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "973fa31c-ed03-429b-968d-0fb879fa08a9",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-10T01:04:53.8504926+00:00"
},
"company_sector_id": "5ff755f3-3e68-4c8d-bd8b-fde2ba0b400b",
"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": "355157f5-855b-4c18-babe-b4b932da3efc",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "066543bb-fa32-486a-8c12-016ae5528231",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "5c48533e-631d-4c5b-857b-3be6fccce459",
"account_manager_user_code": "sample string 56",
"company_status_id": "31c838bc-ef48-44be-a878-cfe78a163b55",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-10T01:04:53.8504926+00:00",
"id2": 60
},
"db_language_id": "bae11810-b988-4b8c-a03e-5423de731ed1",
"db_language_code": "sample string 7",
"db_title_id": "612790fe-eaea-4140-8c3c-5b90a3204016",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-10T01:04:53.8504926+00:00",
"create_date": "2026-04-10T01:04:53.8504926+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-04-10T01:04:53.8504926+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.