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": "62f0be6e-597d-4b65-9e3f-a5620aefee02",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "04d59ebe-86ee-470d-a506-eee2e4206d30",
"company_code": "sample string 5",
"company": {
"id": "28c53d2a-ff89-4a15-8ec0-bb4036eee767",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-20T15:29:34.1102424+00:00",
"sales_territory_id": "ffe1816b-2f52-4ffd-8f65-8fc61d2e6a09",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f7ed1897-3101-4ba7-a5ba-61cb1464d83f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e63a3cf0-8537-4a80-b7d8-5dccb1e5cf9f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "dea539f2-733f-45a2-a39c-1d6d3c08b35e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "66c6ce3f-dcbe-4eca-8db0-10d2d0f764c5",
"db_currency_id": "b1d3eb6e-ed4a-4f48-8bbd-d058e9bd6e75",
"db_language_id": "cd4a1afc-5b68-4e98-8065-398d314b2821",
"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-20T15:29:34.1258672+00:00"
},
"modified_dateutc": "2025-10-20T15:29:34.1258672+00:00"
},
"marketing_segment_id": "8799caeb-9d31-4516-882c-aefb24b73e5b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "18b84d30-ce6c-44aa-aec1-d95558a08901",
"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": "3e9ed43e-ce02-4c5f-ab2a-562bd539da44",
"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": "d545cd14-fbcd-4d08-bfc9-8e4fd21a0223",
"db_country_code": "sample string 28",
"feelist_id": "e4b4fe19-0975-46c3-9106-4315ec882d27",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3f770566-be5f-4966-91cc-4a44ac9c35b2",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5a921b0f-0f18-4512-949b-ffd777c27d67",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-20T15:29:34.1258672+00:00",
"db_currency_id": "64106b62-9dc8-42ab-83d3-2a9d93188e9f",
"db_currency_code": "sample string 10"
},
"company_type_id": "4a6de7f3-946f-4b96-93d5-738e238b742b",
"company_type_name": "sample string 32",
"company_type": {
"id": "633c9224-5c3e-488b-ba52-c1acad047e06",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9f339fd7-5c36-4987-a1ba-2c669224208e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7a784d37-224a-4c60-8ded-5d5d5b0f4233",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9d4c08c5-0e9d-4ad1-9125-f46237dc90e6",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "afac545a-f11c-4a4a-bfac-45038bba0b58",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ea3e3614-87e0-4c17-abcf-99c924c8a849",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-20T15:29:34.1258672+00:00"
},
"company_sector_id": "07136343-aeb5-4a39-be32-9aedf563abd6",
"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": "8eaee7be-a2ab-4ef7-a71e-b5bb789d6a0d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "df1e6e72-aaf5-46f7-b3b6-613d18db8a5e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f497bf8c-9186-431e-a57f-da69f8481241",
"account_manager_user_code": "sample string 56",
"company_status_id": "974a6c48-fe54-4c69-b316-8ba01404ef0e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-20T15:29:34.1258672+00:00",
"id2": 60
},
"db_language_id": "c42f096d-40fd-4985-94e6-a4a6351b519b",
"db_language_code": "sample string 7",
"db_title_id": "a45e078d-2951-48c3-8ac3-515247f4c274",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-20T15:29:34.1258672+00:00",
"create_date": "2025-10-20T15:29:34.1258672+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-20T15:29:34.1258672+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.