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": "5248a69a-3d7a-4bdd-b98c-446cfb742971",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "07639870-b200-4c9e-9a2d-84f5c7013576",
"company_code": "sample string 5",
"company": {
"id": "3bc45f50-80ac-413f-8399-e3fb4433c568",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-06-26T11:24:14.4714564+00:00",
"sales_territory_id": "95cbcfdb-19fb-4e4a-8d12-73021733b1d4",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "cdaa9fb9-b7a5-4f14-b54f-54174ab71df3",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "eae1226e-8ac4-4636-ba59-3b3e83632908",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "523771ad-414c-4c1c-acb5-24cdc710b18d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ff1152be-adf7-45a8-8526-abaaa0a3d8a0",
"db_currency_id": "e1aa7f57-4bba-4601-b5a7-0e543dd1ab0d",
"db_language_id": "69976a4b-0ccc-43b6-9744-b57d03780ac3",
"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-06-26T11:24:14.4714564+00:00"
},
"modified_dateutc": "2025-06-26T11:24:14.4714564+00:00"
},
"marketing_segment_id": "adad7789-d580-4b88-8667-88f5b34128ac",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "56c7654f-941f-46e7-bcac-8075f057cb32",
"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": "01709864-497c-4306-94b7-05fa67fd6c01",
"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": "8a9343aa-7cd6-433c-bdf8-ad17ffae2329",
"db_country_code": "sample string 28",
"feelist_id": "d9b01743-170c-46b5-b8d3-9e78b29ccf43",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "98a7d9d5-de7b-464a-ad66-add021ef170d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e7aed6bb-c672-4b83-89ca-36ceb11ac79d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-06-26T11:24:14.4714564+00:00",
"db_currency_id": "62a4bd4e-c3b4-4516-95d3-20c3b8a8f17e",
"db_currency_code": "sample string 10"
},
"company_type_id": "e0af8193-5e93-4adb-9b02-3f295fd2d0fe",
"company_type_name": "sample string 32",
"company_type": {
"id": "79c626c2-13dc-424a-81c5-53cfb68c054c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4d6e4b99-8946-4f59-932b-a7e40150d325",
"sales_organization_code": "sample string 5"
},
"db_language_id": "04831d8f-0037-49c8-bdd2-a202c0f49603",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0a52c1ec-2cef-4cd4-a411-95fb41c295f3",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "2147efeb-feb5-459c-87f4-771aef839028",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "82ff4f79-47ba-4be1-b585-93bac9c58c7c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-06-26T11:24:14.4714564+00:00"
},
"company_sector_id": "597a4b6e-5002-4dc9-b55f-6d9b11176479",
"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": "48687f1a-7bdc-42f5-adb7-547c0144887f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "93a29304-b2c0-447a-92b8-1e2519b22aa4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d73122c2-4c9e-4ca1-8e7a-14fc954c29cf",
"account_manager_user_code": "sample string 56",
"company_status_id": "543707eb-7800-411a-b8a4-92d3e6272a97",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-06-26T11:24:14.4714564+00:00",
"id2": 60
},
"db_language_id": "5672c38f-c133-4398-b5ba-512582c51a68",
"db_language_code": "sample string 7",
"db_title_id": "46419a7d-54f9-4b55-893e-e2e7f8d451ff",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-06-26T11:24:14.4714564+00:00",
"create_date": "2025-06-26T11:24:14.4714564+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-06-26T11:24:14.4714564+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.