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": "10887c88-8298-4c4c-9849-bd96a3c79ebf",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3940a0b0-4c86-43b0-b703-43cd9c21aaf3",
"company_code": "sample string 5",
"company": {
"id": "042c23b1-5f62-4f1d-9bfa-e8ebfbbce713",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-27T19:51:02.8415782+00:00",
"sales_territory_id": "c137a7c7-5f9e-48a5-97c8-e1118d3c5429",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b064f8a6-0fb3-44bb-aa8d-22efe69657f3",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "809ebb64-b2c7-47d2-a740-e3dab1831bd9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2f10bcc8-8073-4a8b-af2d-00b585c32efd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7712fcfb-57bb-48da-8cfa-e2aa25fa34e6",
"db_currency_id": "a9de9478-0442-443b-a3a8-13a055bd6049",
"db_language_id": "083e00d1-9266-4c48-8a76-b6cf03a148b5",
"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-08-27T19:51:02.8415782+00:00"
},
"modified_dateutc": "2026-08-27T19:51:02.8415782+00:00"
},
"marketing_segment_id": "065a5b89-a60e-427d-9942-afbaf6840695",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "48987dda-4b5a-4eb6-b732-dd0e5929777e",
"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": "a6c9f39a-388f-4fe6-89c5-2b10b7d36cb2",
"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": "defb7fe9-32b8-400f-8282-98c2eae96465",
"db_country_code": "sample string 28",
"feelist_id": "8f37b561-847d-4d11-9167-68eb4f550b05",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1b7a2829-a71a-4f40-b9ec-d4b48bb64176",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "18b0ae59-5701-4341-a6b1-d29a2bcf41ec",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-27T19:51:02.8415782+00:00",
"db_currency_id": "d6903a13-69e5-473c-be68-bdb1f4fc62a3",
"db_currency_code": "sample string 10"
},
"company_type_id": "c0a7ced3-f43e-439f-9f07-bbbb87838856",
"company_type_name": "sample string 32",
"company_type": {
"id": "92a99324-a381-4969-b17b-17b9bd790fa9",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d0940c0b-c1b8-43f5-a205-c755d17e8fda",
"sales_organization_code": "sample string 5"
},
"db_language_id": "591549e7-267a-40a6-9cae-ec58b3a25db4",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "eb672c98-7ca0-4e74-a3d7-480fccc4ea00",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "068d1b6e-cadb-4715-b7de-be826a2f16dc",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e9bd61d4-0694-4c9e-88bb-f44ef3473881",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-27T19:51:02.8415782+00:00"
},
"company_sector_id": "73f07819-2e21-4a77-88ed-2397d4c619d9",
"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": "ac2e9ecc-c47e-434b-ac9d-27a133329fa4",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ee5d414e-47ea-4bfd-98ce-e732517b8502",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "784194bb-138d-4b7d-8800-2c59873c4f41",
"account_manager_user_code": "sample string 56",
"company_status_id": "ae860a02-6a5b-458c-9f68-5b2cbb17afc5",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-27T19:51:02.8415782+00:00",
"id2": 60
},
"db_language_id": "5a347eef-9e4a-4d07-ae7e-7c6da52d9aa8",
"db_language_code": "sample string 7",
"db_title_id": "c1b1b7be-a1a9-4c43-91ca-6787ae59a854",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-27T19:51:02.8415782+00:00",
"create_date": "2026-08-27T19:51:02.8415782+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-08-27T19:51:02.8415782+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.