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": "08ac1f0f-c25d-4a37-adbe-a2f09f372f81",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0ee00b9f-5c7f-46d4-8854-812fe2375ee6",
"company_code": "sample string 5",
"company": {
"id": "ca6b406b-ffc4-4115-a4d0-35570d168c33",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-04T23:13:15.9818701+00:00",
"sales_territory_id": "65a0e5ac-0352-4c92-85ed-797d1a2e3b96",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "be460307-ad48-4b0a-ae6b-f90993ca17da",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "67f079ce-4965-4ec3-ab02-a32d2a095150",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "778bfa3f-da90-4f96-8209-dd9b82b4e937",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4db7709b-bf85-44ad-a8fe-3445d93d34c5",
"db_currency_id": "8818695e-0ed0-4750-af66-782d2f3f3e88",
"db_language_id": "b4f6ea20-62c8-4670-9d8c-3e5593d9296b",
"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-08-04T23:13:15.9818701+00:00"
},
"modified_dateutc": "2026-08-04T23:13:15.9818701+00:00"
},
"marketing_segment_id": "741be9ab-1268-488b-84f5-6d69b376df67",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "10e348e6-0f7e-41b7-afdb-6c074926e8a2",
"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": "6cd5075f-9986-4fb1-a914-e21fb5f83076",
"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": "7b6d4dfb-b4f8-4f5d-b0c7-2e563cc79e6c",
"db_country_code": "sample string 28",
"feelist_id": "764521e9-c671-48e4-95b7-d0c401cb46c2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "0d917776-9f30-4f68-8592-b64d483dfe41",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1b73f7e2-7816-49dd-8d64-a3fd88a43310",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-04T23:13:15.9818701+00:00",
"db_currency_id": "c0413888-1c36-453a-89f8-2ceb0f928fd2",
"db_currency_code": "sample string 10"
},
"company_type_id": "39bfccbb-53ac-43ad-bdef-b5b1c611def9",
"company_type_name": "sample string 32",
"company_type": {
"id": "28474d36-542b-4304-b090-f5bf12b33373",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e41442d0-ef3a-44e1-870e-b183ccc015fa",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0e226528-35f4-4604-b657-e87b89dad067",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f7437d32-edc1-4ac0-9ef2-a9ee17c75c52",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ea262a92-0bfb-45b2-885f-f52c78193b7f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "30ce08e0-1651-49cf-9505-ba0a9ad0b353",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-04T23:13:15.9818701+00:00"
},
"company_sector_id": "d6d872a8-877c-4907-97fd-2a5271f75980",
"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": "426166ce-a793-4a48-a9df-c7123deb057e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c165e3e7-e712-4e89-8d6f-69bdcda4f9c4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "24df7406-4fd2-41e8-8b8d-935d964fb926",
"account_manager_user_code": "sample string 56",
"company_status_id": "4319fa13-c138-4708-a100-3ae76a075bdd",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-04T23:13:15.9818701+00:00",
"id2": 60
},
"db_language_id": "b6ed54e8-94e9-4e02-9666-e0fbe611b775",
"db_language_code": "sample string 7",
"db_title_id": "d79a9944-62df-4072-9b53-64b064205c9a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-04T23:13:15.9818701+00:00",
"create_date": "2026-08-04T23:13:15.9818701+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-08-04T23:13:15.9818701+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.