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": "1859c662-27b7-478c-82dc-a879bae6f9e5",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b1f12208-183d-4c49-8888-baafae41bbe2",
"company_code": "sample string 5",
"company": {
"id": "991ad03a-683f-4f1a-b1d5-78e816bb64c3",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-07-15T23:00:16.4228568+00:00",
"sales_territory_id": "2149ed62-dd70-4fab-814d-9f6411d9735c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0ca88915-fd51-4c34-9af9-e3d4a8f1b6d6",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "16e8f085-1ca0-426e-9dcb-dbdac7684216",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8c4d5431-fbbd-46a9-88cd-0396bc6c840c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5aef2661-cfef-49c4-b46b-2c5f446d8212",
"db_currency_id": "3f5de33e-c7a6-41da-9958-e83452c58d0a",
"db_language_id": "afd35621-be0d-40a6-ab88-7e2e835e2b4d",
"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-07-15T23:00:16.4228568+00:00"
},
"modified_dateutc": "2025-07-15T23:00:16.4228568+00:00"
},
"marketing_segment_id": "b3fc5a57-2499-4ab9-a517-a0a19b2026e0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ae941d5b-be32-4ad7-b826-75fc929d7c88",
"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": "dd15aadc-f7bf-4403-9662-cca9d335dcde",
"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": "987f0101-a655-41e3-8009-e2ca41ca40a8",
"db_country_code": "sample string 28",
"feelist_id": "656062f5-6854-4da2-8a0b-71b649197211",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "fdbf9414-9434-49c1-966f-93fbd5708159",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e6c74810-36cc-4f1a-9a66-fbbcb9b26687",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-07-15T23:00:16.4228568+00:00",
"db_currency_id": "6a63c5a0-222c-4673-b873-f3e6209fca5c",
"db_currency_code": "sample string 10"
},
"company_type_id": "e6ca5cf0-bb50-4629-8594-1334a5596ce1",
"company_type_name": "sample string 32",
"company_type": {
"id": "16cd3d38-54e7-4442-bf7b-14de8a9a718a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7014c0bf-4437-4ae4-bfc4-39d15852638a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0a5b8975-43cc-4d9e-a438-a9f251c5f020",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "2c0a587b-7fce-4ec3-9a9a-796d7a6f0c2f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "db80806f-b05e-42bd-a9dd-e8f5af669e22",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "bc1ef5fc-603a-40e6-b0f7-d8a74dd30b68",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-07-15T23:00:16.4228568+00:00"
},
"company_sector_id": "48cb7bb1-b4ff-47fd-b26d-3195b72cf3ea",
"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": "ba495886-098b-4d14-8ca4-0598c8ac1139",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "77c7bca9-db4f-4099-99ee-c61e6eeab0d7",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "441f392a-127a-413f-a516-9ea66b08558d",
"account_manager_user_code": "sample string 56",
"company_status_id": "e5c56ba5-6b69-417a-b4fb-e1c8cb534f2d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-07-15T23:00:16.4228568+00:00",
"id2": 60
},
"db_language_id": "c8c0e59d-9740-4154-b820-10438ad3b81f",
"db_language_code": "sample string 7",
"db_title_id": "71f32b61-d752-4219-966a-5089a57f4d26",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-07-15T23:00:16.4228568+00:00",
"create_date": "2025-07-15T23:00:16.4228568+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-07-15T23:00:16.4228568+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.