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": "0588aaea-f25d-4f2b-a4d0-f177d9db13a5",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "bd335621-492e-474a-bd52-55c188dc6ce0",
"company_code": "sample string 5",
"company": {
"id": "6e03dea5-4402-4330-95fc-f62d707ff71b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-31T22:37:11.151212+00:00",
"sales_territory_id": "f5d3941f-dc59-4a34-9d38-34255533b4d0",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "82fb3da8-d744-45d6-86f8-721db2f4da0f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5883745b-1799-43f1-b774-79e402827289",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "797d3cfa-3c94-424c-911e-11ec2f5b073c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1b70e9d6-49c4-41c1-ac36-97c8f5ee2f17",
"db_currency_id": "7d450b93-0112-4cd1-ba8c-2178dc194559",
"db_language_id": "2e22c64f-3323-4d62-b6f8-a840a4c900ff",
"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-10-31T22:37:11.151212+00:00"
},
"modified_dateutc": "2026-10-31T22:37:11.151212+00:00"
},
"marketing_segment_id": "6f4d8f3f-29c8-44c0-a285-a13a5404ace0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2b37babe-94b6-4de1-8b6b-78f1ca50821d",
"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": "872f3406-f881-4604-9036-dafa2f00221a",
"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": "ac18f510-ed98-4804-8130-74c7a984300f",
"db_country_code": "sample string 28",
"feelist_id": "6705d1b5-3393-45a9-8c63-98b9b9918856",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5e40db86-fcef-4d0c-a6e5-5539201f6b8b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "405ebe8e-9606-42d8-9227-6539f296cf0a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-31T22:37:11.151212+00:00",
"db_currency_id": "415fda10-20e5-4f6b-9ee1-4ed29e496bf2",
"db_currency_code": "sample string 10"
},
"company_type_id": "a8a6e0bf-14ab-4e5b-bf99-f4cb8736c6aa",
"company_type_name": "sample string 32",
"company_type": {
"id": "52f0719f-d824-45fd-aad1-c68813de7a30",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5583cb46-f274-4ed8-afcf-5ecd5c90a22a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "34702bbd-2f30-4144-9f88-63092a1e4ac3",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "b7ba53f8-a7ce-4e40-98f1-4c7ec967dea1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e745342f-c58f-4728-9c48-c2e3c512e97e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "51501ab2-a89c-45f6-a0fb-65d1ef011600",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-31T22:37:11.151212+00:00"
},
"company_sector_id": "7c4f2969-a58a-407e-ab39-7bf09b24859d",
"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": "70f454f7-e001-4f73-aa7a-3be72c5d3cee",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "68f78379-6ed6-4767-9386-5654a5889ebc",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "2adc2f70-c2fa-4c54-993f-7379b2d924c0",
"account_manager_user_code": "sample string 56",
"company_status_id": "3c2c33cc-5d21-44a1-b5b7-7ea9b06971d0",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-31T22:37:11.151212+00:00",
"id2": 60
},
"db_language_id": "ccbacd4a-718e-4452-9879-b63f4a493a5e",
"db_language_code": "sample string 7",
"db_title_id": "7646367c-cb7c-4cbc-a904-76b8b1e1b87a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-31T22:37:11.151212+00:00",
"create_date": "2026-10-31T22:37:11.151212+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-10-31T22:37:11.151212+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.