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": "d34b2e6c-8e19-42ad-8191-5099a824c4f1",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4ffbf28b-77de-4a75-995d-8b6f78c29631",
"company_code": "sample string 5",
"company": {
"id": "e21a6f79-7189-4560-8abe-771eb15fafc2",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-31T09:48:20.1661193+00:00",
"sales_territory_id": "bf642309-f32d-49cf-b446-3ebf3e6d2bf6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "76657e6f-9b63-4d7c-add8-73e28e545f8d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bdf66166-3735-4b9f-9933-0934db599fdc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "863e8423-99ec-44f7-a8ee-40a6eea7936e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fa14011f-1c3f-4afa-abd5-18c66999ce3f",
"db_currency_id": "604aa5b7-ab7d-43cc-bf06-d50d057b8efc",
"db_language_id": "fc4cddfd-7a25-46e7-8aa8-04b65c67d09e",
"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": "2025-12-31T09:48:20.1661193+00:00"
},
"modified_dateutc": "2025-12-31T09:48:20.1661193+00:00"
},
"marketing_segment_id": "3ca7f492-5d68-4009-a86e-c03cf81159b4",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c96fcf3e-87ea-46e7-958c-c4e1ef6f7f3d",
"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": "a54e35f5-e2d8-446b-bf9a-5e4ce823d847",
"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": "506e3d38-8a47-4e78-93e9-97d8753599d8",
"db_country_code": "sample string 28",
"feelist_id": "db030865-b4d9-4547-8cae-2a6ba87a16ce",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1c8bd39d-704b-427b-ad70-e7e4a8ee557b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2ea3af24-257b-41bf-b4a3-6099fa429853",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-31T09:48:20.1661193+00:00",
"db_currency_id": "23e48368-2bd9-4507-898b-709207574772",
"db_currency_code": "sample string 10"
},
"company_type_id": "701de441-a9b4-4af2-b738-2d916dca9916",
"company_type_name": "sample string 32",
"company_type": {
"id": "9042ff58-1528-425d-8255-399d2ced7710",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "dcb2adb5-8574-460b-a0ed-336197733502",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5e4647e6-c621-4997-8606-7532c98c29c3",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "88b23961-82c9-4eed-9519-6c310008e2a9",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "33b54e2c-41c7-4504-8704-6468fdd20bc0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "16da8b46-5f48-4c3a-87cf-9d9eb2e9335f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-31T09:48:20.1661193+00:00"
},
"company_sector_id": "accaf250-367c-4f66-aa5d-e84d77c92567",
"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": "9ae5918f-0d5f-4d27-a7af-a7d44d89fca2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "41b2af43-23de-48ef-867a-da39bdae3a9d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8113cf07-484f-4a0f-a4b4-85f7fd83ffac",
"account_manager_user_code": "sample string 56",
"company_status_id": "e7194c77-f452-45d8-a58e-00679c0064ca",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-31T09:48:20.1661193+00:00",
"id2": 60
},
"db_language_id": "7da8463a-9d08-4372-be33-f93f54e918ee",
"db_language_code": "sample string 7",
"db_title_id": "d02df7ce-494c-45ca-bee9-0177284dd566",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-31T09:48:20.1661193+00:00",
"create_date": "2025-12-31T09:48:20.1661193+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": "2025-12-31T09:48:20.1661193+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.