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": "c1883a8c-d264-4c92-8920-1caed6583c6d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ac120f51-2fce-44f9-8455-a5946052af26",
"company_code": "sample string 5",
"company": {
"id": "5815b9da-9f70-4d20-9e2a-49d7e8e3f723",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-02T23:55:50.6989144+00:00",
"sales_territory_id": "1d025e05-5fba-442f-bc87-d545cdf99b88",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "abcdf20e-5ab1-4191-84cc-96490fc9d062",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e1a78277-72ae-4578-9e44-81da2d3ce273",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "dec9a465-b30e-44d2-9832-aecf6b052db7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9e786ce4-6704-4581-823e-aea143cf585b",
"db_currency_id": "4550f552-365c-49b2-9661-c229a95e5e0c",
"db_language_id": "71db2def-af84-4ea9-b1b7-5d0c2fee85cd",
"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-10-02T23:55:50.6989144+00:00"
},
"modified_dateutc": "2025-10-02T23:55:50.6989144+00:00"
},
"marketing_segment_id": "36062134-6cb9-4898-af3f-0fbd95fb87a3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "35071b07-0681-4688-b481-dae9c36944f1",
"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": "044b68a4-f759-4af5-bd3f-21937779e049",
"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": "4ec7da0c-975d-4166-895a-abae74691c71",
"db_country_code": "sample string 28",
"feelist_id": "2eaf6e6c-f62f-46b7-a4e3-1ccfbee35e4a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "7ad50833-b544-450c-9f97-0f23ac35efd7",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8ceb817e-4633-4d42-9bd2-398d508890a5",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-02T23:55:50.6989144+00:00",
"db_currency_id": "82aa2b16-dacf-421c-9146-e91becea7278",
"db_currency_code": "sample string 10"
},
"company_type_id": "d7882903-3917-48d1-a1c0-4214c17c9a0e",
"company_type_name": "sample string 32",
"company_type": {
"id": "9332eb1c-d708-46db-9ebf-b6081796c008",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "50dcd63d-a729-49aa-98ac-a5cc42ea1522",
"sales_organization_code": "sample string 5"
},
"db_language_id": "563b23c2-5add-4471-912c-24440754e441",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7920cc99-8ad5-4f5c-b8d8-b15b757d8799",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "9bdd0f7d-d9f4-417d-a3ab-f3b8604d42dd",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a8465273-f992-4954-b277-0f997dc7fe10",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-02T23:55:50.6989144+00:00"
},
"company_sector_id": "639abe8c-95ec-4cad-8a51-a4be021a14c1",
"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": "5d012b61-213b-4b26-b52b-aa755cda7c78",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ad4ccd9b-dc61-4ae4-8a2b-fd3aaebcb302",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "fd93595c-d8e3-46a0-8fd2-7d45ecb4b667",
"account_manager_user_code": "sample string 56",
"company_status_id": "d9078741-61d0-41ad-9abb-b7d9f3968e05",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-02T23:55:50.6989144+00:00",
"id2": 60
},
"db_language_id": "cd936d04-f0f9-400b-b7d4-51fdd9aa1c0a",
"db_language_code": "sample string 7",
"db_title_id": "7f92d10d-cfae-4452-8d6e-80e981878b9b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-02T23:55:50.6989144+00:00",
"create_date": "2025-10-02T23:55:50.6989144+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-10-02T23:55:50.6989144+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.