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": "70bee741-a248-4d21-87bc-97ad568c6fcd",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4bcdfed2-a752-4a71-b7d9-5125d523f87c",
"company_code": "sample string 5",
"company": {
"id": "a5d68ad9-4926-47e8-8a94-99fa11b973d2",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-07T20:57:15.3003859+00:00",
"sales_territory_id": "5086ff0b-84e5-48c0-8fe6-cd6401aed73e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "cf7b2131-30c0-42d0-9d6f-83acb82731d1",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6ed27785-94fa-4efd-861d-b1e77c79306d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "64567b41-f52d-41c4-a0fe-f505dad72d48",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "43154a08-063c-4b31-93ea-e185db7b2623",
"db_currency_id": "7b886340-0ae1-48da-9f04-07c43735979f",
"db_language_id": "a210a831-1dda-4a2e-965a-dcc440e7bbf6",
"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-05-07T20:57:15.3003859+00:00"
},
"modified_dateutc": "2026-05-07T20:57:15.3003859+00:00"
},
"marketing_segment_id": "ab5a737c-e057-4e84-aebc-b501ee64efa4",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "cd4971b1-0902-4a92-a07f-1e2fa3ef9740",
"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": "3913dbe5-a9d8-48d2-90a1-1115b96e1ea8",
"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": "e66f0e97-d060-401a-822c-ff8b18bad7fc",
"db_country_code": "sample string 28",
"feelist_id": "d41ea2e3-c9bd-47d5-ab27-cb0abf189bfa",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "fa6d0999-c9b5-4123-91b1-4630d16d53c2",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0e26b23d-c252-4e3c-bc7d-5404441ac80a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-07T20:57:15.3003859+00:00",
"db_currency_id": "4e230ef8-d028-4560-8fe3-03db7fb846f9",
"db_currency_code": "sample string 10"
},
"company_type_id": "52c7ee02-5740-4910-964c-1c183863a623",
"company_type_name": "sample string 32",
"company_type": {
"id": "2ba1df71-0909-4eaf-bbb5-70cb9afbf0e9",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3073f630-77d5-4be7-a120-558e4c44910d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9d4393b9-1795-4fc8-afa5-57e32248e2d8",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "52418918-6ee5-4c06-a559-786e97a8e428",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "dd424a8a-dfa0-4041-9bd1-2ea5694547c8",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c672c82c-ace4-4886-ace7-afb3d6600c87",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-07T20:57:15.3003859+00:00"
},
"company_sector_id": "613697d9-7b75-448b-a222-b3b9ee1a3883",
"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": "a92ab93d-a2e9-4803-8ecd-220fa8e70561",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1b887dff-857e-4c8b-8f7d-f38a1686f101",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "86943aa4-8c5d-42af-ac7a-63bc1690cc0b",
"account_manager_user_code": "sample string 56",
"company_status_id": "cd93f759-c861-4dbf-8627-9e44fd412f5e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-07T20:57:15.3003859+00:00",
"id2": 60
},
"db_language_id": "713ab9e1-80d8-4fe8-b39f-767a13f58681",
"db_language_code": "sample string 7",
"db_title_id": "e83e33af-a0e8-40e6-add1-e43e2ac9cf98",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-07T20:57:15.3003859+00:00",
"create_date": "2026-05-07T20:57:15.3003859+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-05-07T20:57:15.3003859+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.