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": "aeb17b4c-d775-4d5e-b356-95c5d78f038a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7deb9e7c-58a1-4835-bb4b-76969baed7d3",
"company_code": "sample string 5",
"company": {
"id": "f9daedbf-54ab-4179-b56b-fb66784555a1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-18T06:06:05.4160107+00:00",
"sales_territory_id": "3e2af4eb-cb11-455e-bab5-1da1a3594d40",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "bf0d5d5f-ccce-4ab3-adc8-b4c59f2a138c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2692a5cf-39b3-4b0a-8bcd-68f41ef4266a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4d3c33e7-b1bc-4013-b5cf-7d2c40137044",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9a496a23-7b60-471c-a79f-c3f64559e654",
"db_currency_id": "cf9c82a9-ffb6-49fc-b962-6bfedffd9bdb",
"db_language_id": "f002c889-8e6f-41c3-99df-7e6e4b0a6639",
"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-01-18T06:06:05.4160107+00:00"
},
"modified_dateutc": "2026-01-18T06:06:05.4160107+00:00"
},
"marketing_segment_id": "0e5e0c6b-4a2c-4372-92d6-1929a6befa1d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ace1a157-acd8-4fdb-8460-0abe29acc878",
"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": "f6e56fa1-c7a5-4957-aca8-d6d5dff0b078",
"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": "92c257bf-c847-45e5-8dd2-076f3e342e66",
"db_country_code": "sample string 28",
"feelist_id": "4eb0aab3-1052-47bf-94f7-9db5433a3f0c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f2c6607c-c569-40fc-b082-5f11e114d8df",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ab633d0c-b746-448d-9749-874b39dde958",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-18T06:06:05.4316337+00:00",
"db_currency_id": "ad63faf0-4df5-49b5-80d5-846c12a09209",
"db_currency_code": "sample string 10"
},
"company_type_id": "33a6f967-16d5-43eb-b751-018c2b5f24d7",
"company_type_name": "sample string 32",
"company_type": {
"id": "1eb05d70-2c03-4811-9601-fea003139082",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "68d663e9-6fc6-4439-9924-511037d5f0e0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0a9779f8-b26c-40ce-bdaf-e6b411ae0fcb",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f9ebb12c-8ae3-4c8e-a132-b941f45cf51f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "fb50a7b7-6436-4f2d-bb6d-da3354b7e717",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f1e2763f-ba2f-48d6-8c12-f437a308ca1c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-18T06:06:05.4316337+00:00"
},
"company_sector_id": "8e4952b2-cd3c-446f-a0e9-9b7892f1d38d",
"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": "0bc5ec56-a073-4a2f-a407-9801143a0b3b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9ef92ed5-ea84-4990-86c1-7002743b91f7",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "6efb68bd-d14e-47c8-80bf-8599ec2ae493",
"account_manager_user_code": "sample string 56",
"company_status_id": "555833f4-0c18-45eb-9bb1-e4f2b4a2ff94",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-18T06:06:05.4316337+00:00",
"id2": 60
},
"db_language_id": "6fbe6cc5-d588-4f97-a31f-3107aea23864",
"db_language_code": "sample string 7",
"db_title_id": "de81fe2d-bd27-4fc0-9866-af52ad7cfaed",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-18T06:06:05.4316337+00:00",
"create_date": "2026-01-18T06:06:05.4316337+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-01-18T06:06:05.4316337+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.