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
{
"id": "02a82048-a6c5-494a-9842-3257934b8055",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "da04c84d-c431-4c49-b12b-cb9ad4cf145f",
"company_code": "sample string 5",
"company": {
"id": "a5386bd5-f458-4a6f-aaa3-992e62b2b2d9",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-26T22:31:26.542441+00:00",
"sales_territory_id": "901ca9be-a2f9-44b2-8fc8-9fc9cab57feb",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "10abe067-3cf8-4cea-9b81-36b0973a3841",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "48eae379-ac06-4a7a-9287-7c1832dc7dae",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c9a832a2-7a35-4092-ae50-a7e63169a45c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d68ade1-5f75-46bf-92f8-0cd042a593b1",
"db_currency_id": "7d16a5a3-c328-4fdc-b98e-a53c89959168",
"db_language_id": "bb09ce95-1ccc-4744-a061-7a02cff0a335",
"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-07-26T22:31:26.542441+00:00"
},
"modified_dateutc": "2026-07-26T22:31:26.542441+00:00"
},
"marketing_segment_id": "209ca978-8f6d-47c8-90b3-931047f400a3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "af569b81-e661-4031-a9ff-6b1633303887",
"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": "d038e1fa-7be6-45e3-af5f-98d8ddf0b25f",
"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": "7f57b6b0-8009-43f1-b351-695d5c5af69f",
"db_country_code": "sample string 28",
"feelist_id": "9c5b75c0-9f0a-489b-9be6-e1b42dcc118d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5f519cee-bc9c-4ff1-b1f0-040f26fbbf28",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c796271a-5dcf-41ee-a3e7-58099427c362",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-26T22:31:26.542441+00:00",
"db_currency_id": "4e7b597a-1c74-46bf-8570-76475cd0d93d",
"db_currency_code": "sample string 10"
},
"company_type_id": "56e5490c-098e-448b-995a-fc205a20fab5",
"company_type_name": "sample string 32",
"company_type": {
"id": "9304e123-fc46-45eb-b2ab-2d8959a7e0c1",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "48737c36-e166-4f55-b01a-ab02ba0bbc0d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "40b1cbda-0d31-4813-852d-c270de4a9c00",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "bfa9bfbd-1696-43f4-aea6-4efc703160de",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "778599b0-4bf4-4c7c-9bb1-1ff98062b179",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "6da88e76-d560-4cad-80cd-ae42f886a02d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-26T22:31:26.542441+00:00"
},
"company_sector_id": "3bc04b16-0754-42c8-ac3b-7e4d4102011f",
"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": "d7d06086-4b26-4b09-8bab-a43ba4112e68",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f7a32bf5-347f-4db4-831f-fecef8a3b3e5",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c1d7e1b7-fc7b-4ed3-97ab-fbaa296e8790",
"account_manager_user_code": "sample string 56",
"company_status_id": "ee7c6cfb-817c-463c-b706-c2e05666eba9",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-26T22:31:26.542441+00:00",
"id2": 60
},
"db_language_id": "501fe1bc-6367-4c69-81ef-f2e813479647",
"db_language_code": "sample string 7",
"db_title_id": "476fdcf6-561b-4ef7-9026-48aca4329fbc",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-26T22:31:26.542441+00:00",
"create_date": "2026-07-26T22:31:26.542441+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-07-26T22:31:26.542441+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.