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": "853d6c61-d574-489a-b5d8-963d96c578a6",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a7e6f0f2-6ca0-4c6c-a05a-494fa5f47d8e",
"company_code": "sample string 5",
"company": {
"id": "fa170f35-7b37-4d43-9192-46df834f4be9",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-18T16:34:38.2661651+00:00",
"sales_territory_id": "ef73f852-963b-4a85-940b-8c09f10a109b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "827d2dbd-cac0-4933-b0db-069cfbbcaad3",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8a3ecc2f-4902-4729-952b-ae7a230ecd92",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b5bf07e8-5ef5-453c-96f7-b946f2f5a3b2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d9ed0d9e-49f6-4ef6-b039-5e7d8e0fac64",
"db_currency_id": "bbc450b9-b65f-49bc-86f5-df0e2482cbc4",
"db_language_id": "a43a15e4-5244-4fd2-b992-879f7d30bcdf",
"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-06-18T16:34:38.2661651+00:00"
},
"modified_dateutc": "2026-06-18T16:34:38.2661651+00:00"
},
"marketing_segment_id": "e98d4640-f305-4527-8a69-b2840daf607f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2181d27e-9eb8-4bbf-b57c-fdf41a9f7b12",
"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": "01c522e1-e702-46a6-b532-4f3085fa0db9",
"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": "a299ff21-9802-4e4a-a355-3694828f056d",
"db_country_code": "sample string 28",
"feelist_id": "3a521bce-0673-4d11-8fde-7d26fbae6323",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5421e385-a1b5-4425-b0e4-bcd0f8a8125a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d4f80dc6-b65b-4b2a-98e3-150df94398ff",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-18T16:34:38.2661651+00:00",
"db_currency_id": "7eaa1a08-f375-4472-8bbc-38eb5be9785d",
"db_currency_code": "sample string 10"
},
"company_type_id": "c109d2fa-5392-4d2c-a9ce-5206b48fc10a",
"company_type_name": "sample string 32",
"company_type": {
"id": "b1805f0b-7c90-4a09-b6ff-588966a1640f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a81ab249-ae21-4624-bbb4-173b944ac87b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a83819b3-e917-4c41-a0c6-9e25ffe097c6",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7392711d-bf34-4a54-a60f-4ecfe45ce440",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7e330e45-fade-4117-99fe-b7d9871a50e7",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9dbef85f-5733-4a20-bd4a-75a11e55df4c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-18T16:34:38.2661651+00:00"
},
"company_sector_id": "d596b5b2-6007-479d-b041-892d14119451",
"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": "73e1fc5e-e43d-456f-81c3-d57c29f4447f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "278119f9-9edd-4ea7-bd80-1b30dbef0a1a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "95eca30a-7f23-4320-9cb4-b6ac77bcc983",
"account_manager_user_code": "sample string 56",
"company_status_id": "0be434e3-57fe-42dc-8060-ba9bf215b5c0",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-18T16:34:38.2661651+00:00",
"id2": 60
},
"db_language_id": "45d3fb5e-4aa8-487b-b3e8-d10008af4aa9",
"db_language_code": "sample string 7",
"db_title_id": "71b1eb39-605e-4eb4-a523-988f4552b3e7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-18T16:34:38.2661651+00:00",
"create_date": "2026-06-18T16:34:38.2661651+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-06-18T16:34:38.2661651+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.