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": "227cca22-eb60-404a-835b-603d67d0b04a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "97ec2634-67fe-42c8-861a-1dc18ef5083b",
"company_code": "sample string 5",
"company": {
"id": "2dc72007-91cb-4fc6-94a7-f2227ecd16f4",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-20T08:20:04.0859072+00:00",
"sales_territory_id": "d40d0f19-795b-4f5b-b2cb-a0a397f618ab",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7136b9f1-c0f8-414d-a72c-4c5a66d83659",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0e2034d4-6e77-4d71-abd6-2eb456bc60e9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bc7829c2-bdc4-45a7-9520-f2c77a78dfc3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3aafc8b4-3b00-4c48-8356-77faa02bf92a",
"db_currency_id": "a01fab20-98bf-4dc4-89ac-c96d2b3e115a",
"db_language_id": "71a26c8b-502f-4bc2-991b-01b05d3e17f7",
"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-20T08:20:04.0859072+00:00"
},
"modified_dateutc": "2025-10-20T08:20:04.0859072+00:00"
},
"marketing_segment_id": "dbd2830f-cc55-44cc-9d42-a86d30ea27de",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a4e80234-0bd6-4eec-a6ec-2229cc902937",
"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": "91d9712f-56f9-436c-a22e-a855e2effc53",
"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": "c6f2f081-8df2-4fce-a566-fa351f3764a5",
"db_country_code": "sample string 28",
"feelist_id": "36e17357-af78-4dd3-8b8c-971452d9f5e0",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "110a73c5-a222-456d-ab4b-216cad44bf18",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ee680b32-e66b-4e8f-8e78-aadef0cc5c3e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-20T08:20:04.0859072+00:00",
"db_currency_id": "81b57927-0027-4012-9cd0-ef87e576d23d",
"db_currency_code": "sample string 10"
},
"company_type_id": "fb6730c2-5abf-44f4-9fdc-2a692ed9ee30",
"company_type_name": "sample string 32",
"company_type": {
"id": "fcea3f59-8606-4748-9df8-fd61d5122887",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "29eacd69-1fcc-4be3-a823-848a61731cc8",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d8b92929-7030-46cc-aa24-b7ff8a2608c5",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "648f32a9-3742-41b5-a5aa-db5076d44388",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d31a4cc9-4132-4240-b947-92c72e8127ea",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ce8f07d6-99c9-4817-b3a7-6f2a2846894f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-20T08:20:04.0859072+00:00"
},
"company_sector_id": "cbc3e913-c405-46ff-9690-683ef8bc9b2f",
"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": "9425760f-e12c-4682-bbfe-aba6f132305b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e5358faa-1271-4d16-90c1-bd5bef12bd18",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0eaafc1e-f399-465f-9072-bfce6a78ddb5",
"account_manager_user_code": "sample string 56",
"company_status_id": "6fa4ee6a-b5d5-4ae6-b167-eb1cd9b72d83",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-20T08:20:04.0859072+00:00",
"id2": 60
},
"db_language_id": "78b07838-7180-49cb-bfbf-7cb18586c9e6",
"db_language_code": "sample string 7",
"db_title_id": "7bcced0c-e26f-451d-98e9-c7e6048fb722",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-20T08:20:04.0859072+00:00",
"create_date": "2025-10-20T08:20:04.0859072+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-20T08:20:04.0859072+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.