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": "6755dac9-4dd2-4e9e-98ff-2064442564db",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "edd650a5-4e4d-4933-a788-ebe98d87a44f",
"company_code": "sample string 5",
"company": {
"id": "e57d4109-5231-4634-a281-d94b9364ec4d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-20T20:05:25.391724+00:00",
"sales_territory_id": "606ed72a-7847-4704-9cac-1f8ed088783b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a231e14f-6090-4e8a-897f-a24f435cc078",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7cbfa77f-310d-484f-90f8-940eee3b7d28",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "de9efd6d-c602-4e3e-8d7a-83b9fe53c182",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "516cdbcc-64e0-477e-a650-fdb55a255659",
"db_currency_id": "1a7912ff-f9c5-46ed-babb-0d85e6a95b35",
"db_language_id": "b5afc1cb-a2d1-4802-8197-ef0f41d0c34e",
"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": "2026-08-20T20:05:25.391724+00:00"
},
"modified_dateutc": "2026-08-20T20:05:25.391724+00:00"
},
"marketing_segment_id": "6a0b1c20-313f-4da8-ad63-ea2d57b18ee9",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e7ed9028-f6ca-4004-abcb-6e24743bbf83",
"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": "b3381d6d-29cf-4ee0-aecc-d3b58c31b444",
"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": "834b5a77-0fb0-4965-8b2d-6bbd83985e58",
"db_country_code": "sample string 28",
"feelist_id": "00d7254e-6e09-4f95-84db-95a623539ddf",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c820b33c-af2a-4fdf-97d0-4ec9d0e27209",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "90106478-7c7c-4307-ba37-b02dfb7537bc",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-20T20:05:25.391724+00:00",
"db_currency_id": "6ced3270-9c91-40d9-93dd-cc41189dd608",
"db_currency_code": "sample string 10"
},
"company_type_id": "08a9dd51-3baf-4efd-8371-594d86fd364c",
"company_type_name": "sample string 32",
"company_type": {
"id": "0da8197f-1430-459a-9a87-70b6fd25b9f6",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2be7711e-24e7-4c9f-95d3-ecffa42610e4",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c3f87e73-3562-4a33-b769-8fa360f73203",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "2313eb3f-6810-4992-9d30-3bc6cf7eec7b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "018077cf-05a1-4bc7-9bca-cdfc26918d1f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7b1cafd1-15b5-4234-8999-b58a252b8718",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-20T20:05:25.391724+00:00"
},
"company_sector_id": "1c51951e-a6c8-46a9-baff-ffdd863e3fde",
"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": "1f79857f-f5c2-40e8-a5ca-b2de936bed9f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "3d8b2b2d-2d67-4b5f-9e53-ad48a5558de2",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b714deca-dd87-468a-a1df-e41a127931f0",
"account_manager_user_code": "sample string 56",
"company_status_id": "5b8e42c1-92a2-41e9-abea-ab34f1d15211",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-20T20:05:25.391724+00:00",
"id2": 60
},
"db_language_id": "c616ff0f-83eb-4812-991b-1b0a98e40cdf",
"db_language_code": "sample string 7",
"db_title_id": "a37d4a0f-d09c-48e3-8c70-1aa095185765",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-20T20:05:25.391724+00:00",
"create_date": "2026-08-20T20:05:25.391724+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": "2026-08-20T20:05:25.391724+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.