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": "ce1f7b35-cebb-45a8-b812-a71d2661052a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "33c35087-1df2-4977-b85b-7fa41d6dbe0d",
"company_code": "sample string 5",
"company": {
"id": "415780a2-b1f8-4d64-8518-fd25d580fbd8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-01T23:59:50.9699273+00:00",
"sales_territory_id": "ccbbd674-3fce-40f3-bfa0-b07e07ca75d8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "3ef5bd85-e3d4-4d89-9d0b-ccc7fa91db5e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f4746780-4390-4b91-af66-2902e33f6a76",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "146e8364-b4f4-4102-8df8-c15bbdb99ffa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "148853cf-3a6b-4b8d-9e92-b563389a5f7b",
"db_currency_id": "5c2171d5-be02-4925-b51f-1eef58f06974",
"db_language_id": "7faed118-1d5e-468e-9732-46470a12f991",
"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-11-01T23:59:50.9699273+00:00"
},
"modified_dateutc": "2025-11-01T23:59:50.9699273+00:00"
},
"marketing_segment_id": "bb82273a-693f-4f7f-9d48-57bc9ddb2390",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c684541d-0e74-4e5a-b77f-a9ca426e6241",
"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": "c0dea9fe-803b-4d74-a8b6-e93ef0c062a0",
"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": "d69d5246-2d17-43c2-a0e9-3c6fc9752c97",
"db_country_code": "sample string 28",
"feelist_id": "b16b6d0f-d393-443c-9415-1fd045dad3a7",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5de11248-7259-46c9-8cce-668a2e3e46eb",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "50498a7c-d428-455f-8bde-cd574a2b7172",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-01T23:59:50.9699273+00:00",
"db_currency_id": "1e91a107-d471-4814-b999-dcc198d31ff5",
"db_currency_code": "sample string 10"
},
"company_type_id": "24bc9992-1ed1-4d31-98a6-262d2223af42",
"company_type_name": "sample string 32",
"company_type": {
"id": "8fede8a4-3ddb-4d61-8699-72d720780846",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "82f7ac6d-6ad6-432c-ad48-4148f295933e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "527a61af-933a-4fb4-a1a0-58f24e72f2a0",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "fee94e3d-f86c-410d-b96a-8978f14c10d3",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0abc7209-d436-47ea-9574-787bb7b5a07e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5ca4ebb2-0bc0-4ea5-b9b2-d2fe2ed81bcc",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-01T23:59:50.9699273+00:00"
},
"company_sector_id": "b9868eae-7828-428c-9454-bcbad18eb835",
"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": "93de9332-3f03-49c5-ad69-19bec1226241",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "310ae3fc-52f3-45fe-a5c4-844a860a2c2f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b7445b2f-65d3-4032-a163-9cef14964719",
"account_manager_user_code": "sample string 56",
"company_status_id": "cdde0ff0-2783-4fc7-876b-0903143996fd",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-01T23:59:50.9699273+00:00",
"id2": 60
},
"db_language_id": "b265075c-124d-4a87-8e77-705e1f810437",
"db_language_code": "sample string 7",
"db_title_id": "5da0edd2-a276-43e2-b647-f85318e5c2fa",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-01T23:59:50.9699273+00:00",
"create_date": "2025-11-01T23:59:50.9699273+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-11-01T23:59:50.9699273+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.