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": "6e92f187-b2b0-4549-96c9-21210f8831ff",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b710e6c7-3089-4445-b3f6-bcc0cb3c60ed",
"company_code": "sample string 5",
"company": {
"id": "3ec3e48b-33b7-4a21-8034-9bd76e51bda3",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-31T00:28:01.7964637+00:00",
"sales_territory_id": "32722b83-e98b-484e-bc1e-bc8d97230f8a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "aaf2ceb1-ecd6-4f08-9b36-2ad8ac8cdf52",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ee6c3be7-70f8-420e-8a34-0b6b6a17afae",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "20e29dc6-91ee-4617-9c52-2da74b35c027",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2f8e4f5c-94ac-4a3e-8522-23337d73ef18",
"db_currency_id": "500d0e24-2ec8-4b91-9909-3cf40d513c46",
"db_language_id": "097ffc4f-e302-4c3a-b6ee-37c5ec5b202d",
"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-12-31T00:28:01.7964637+00:00"
},
"modified_dateutc": "2025-12-31T00:28:01.7964637+00:00"
},
"marketing_segment_id": "b31d325d-c053-43b1-9cc1-819e96a35eb3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6376c3a7-db7a-4cf3-a2b5-2ca4ccfa0855",
"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": "d05d4ad9-0794-4c8e-b192-654345e97377",
"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": "dc0c3050-b06d-40c6-a80b-eb9c66efefea",
"db_country_code": "sample string 28",
"feelist_id": "bee3546f-e563-493b-8f68-6616db605b4d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "2da65315-87d1-4841-bf6c-91e3d10065b3",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b9ac9192-fb16-477c-a3a4-3493c50d6479",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-31T00:28:01.7964637+00:00",
"db_currency_id": "7309ec19-0d0b-4390-9329-6a341239000b",
"db_currency_code": "sample string 10"
},
"company_type_id": "65468b5b-eb87-4ce3-8708-c918238f2302",
"company_type_name": "sample string 32",
"company_type": {
"id": "7c8df4b7-5100-4840-90a8-3e9b7f16b516",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9400d16b-975c-45db-971b-9a1bea75be0b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6dbf2922-c25a-4171-ada8-ffd6764c9a5c",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "2bf756b8-1e73-4eec-9f47-9dd56531eefc",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a76d5ff1-92e4-4ff1-a8e7-a00d6e4db802",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7903db92-bc88-4453-aa11-73f1928297ea",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-31T00:28:01.7964637+00:00"
},
"company_sector_id": "949245cd-d337-4040-9474-9b1b31f96471",
"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": "0c57c811-ec31-43d7-b937-559e0a86dc78",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "bbe24c86-7b2f-463d-817b-11dd25497c55",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "7aa304a4-3e91-4dad-94fa-e6b935335bce",
"account_manager_user_code": "sample string 56",
"company_status_id": "681b30c0-9f63-4873-8450-74b4284e26a1",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-31T00:28:01.7964637+00:00",
"id2": 60
},
"db_language_id": "7623d3e1-dc32-4fa9-8786-7578c8a7785f",
"db_language_code": "sample string 7",
"db_title_id": "14a0e5f1-aed6-43c4-bfab-1f49372be5c6",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-31T00:28:01.7964637+00:00",
"create_date": "2025-12-31T00:28:01.7964637+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-12-31T00:28:01.8120892+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.