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": "f3df2e6f-4618-451a-ab7d-dcb1722730e8",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "507a9b39-659d-4bc4-9cdd-de949054f6d9",
"company_code": "sample string 5",
"company": {
"id": "f8317900-8b33-4daa-8515-2a9707b2bb31",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-07T16:37:15.3631309+00:00",
"sales_territory_id": "cae9fea1-8920-43c7-8f71-d96b20f3ea7a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "10170495-b1fb-42e3-aaaa-62eb0da68b60",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "30cd7734-74f0-42c6-bb23-0ed331cabe5e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ef1d538d-e9b2-4be2-a3c4-02a90037e04c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f837e2c1-c123-49f8-9161-7f3034c6f493",
"db_currency_id": "a31c0e76-cb1a-4ecf-be5f-d7746ac579ba",
"db_language_id": "90d5a3be-2bec-43b4-b8f7-3338ac0992cb",
"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-07T16:37:15.3631309+00:00"
},
"modified_dateutc": "2026-01-07T16:37:15.3631309+00:00"
},
"marketing_segment_id": "b0b3449f-122d-4eee-bd64-29100a75f0f6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "65d231b0-670a-46b0-96e8-a0abb2b9a61f",
"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": "af2de3ba-e3c5-4914-bade-fbfc759faf16",
"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": "5d3ac6b5-dc0c-4ee8-b7ea-07c03fa7e8ff",
"db_country_code": "sample string 28",
"feelist_id": "d5365795-46ed-4143-9efc-85fbff8e8aec",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "efa70d33-61a4-4346-b41d-aa74a3fc51ae",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "75599f90-df04-4c7d-a3a7-09c847e04305",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-07T16:37:15.3631309+00:00",
"db_currency_id": "5abf3e89-8aff-4986-90c0-f81b842b9719",
"db_currency_code": "sample string 10"
},
"company_type_id": "0097e92d-2a32-4846-b989-f8fefc95492f",
"company_type_name": "sample string 32",
"company_type": {
"id": "d271648e-9151-4487-910a-84386b33b689",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "04bed6bc-1fa1-49f7-96fa-8c6f5df65d7b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "db3dd995-f4de-40ee-b3b3-2e392c590e75",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "1bfda24d-f1ba-4262-a43b-9e216d51fe5c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "2ce2a477-9403-4b02-b5bc-c9dff3b03867",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5004dd5b-7b94-4f5d-87a5-85aea2f184a8",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-07T16:37:15.3631309+00:00"
},
"company_sector_id": "82c24563-1e84-44d7-b09f-70b6bdd83ccc",
"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": "b4981239-31ea-4e32-8aa0-27bc3b48ee80",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5cac3427-fde1-4288-8792-6f01458d5870",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c5b56981-55a5-49e7-ad82-9763a0b8abb3",
"account_manager_user_code": "sample string 56",
"company_status_id": "66bd7500-76fa-4e8e-97d8-2a0bf7e957f1",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-07T16:37:15.3631309+00:00",
"id2": 60
},
"db_language_id": "e0b842c9-5eec-43f4-a058-c770e7fa183c",
"db_language_code": "sample string 7",
"db_title_id": "e5cc4d89-a0b0-4a96-a6df-a57dcba656c5",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-07T16:37:15.3631309+00:00",
"create_date": "2026-01-07T16:37:15.3631309+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-07T16:37:15.3631309+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.