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": "d1c6cbf5-9ec3-4299-b6d0-11f2ee097c67",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1724d07f-06b2-4464-badf-5428550718de",
"company_code": "sample string 5",
"company": {
"id": "4942ae2c-2ad1-494d-9772-495d96f1fad5",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-05T14:30:39.713693+00:00",
"sales_territory_id": "2fe57beb-e18b-4aac-9ee0-0558820f34e7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8d6da8ae-a031-4899-aca8-e5899ca287a5",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "274cfa7a-96ae-4db8-98e2-2585b2e66218",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2ebab10d-f44d-4d45-8992-0d0632abf38f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e2bddcb4-f7c1-435c-8605-121d96994f94",
"db_currency_id": "c7340892-7912-4669-be06-1621c6b5d23d",
"db_language_id": "9a1f5266-2e96-4190-9140-8115245b09af",
"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-05T14:30:39.713693+00:00"
},
"modified_dateutc": "2025-12-05T14:30:39.713693+00:00"
},
"marketing_segment_id": "3bfe3dff-8ebd-4388-947b-36d57dc6ebf5",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "22dc0e15-2aca-435b-9e94-a045a17e7a7e",
"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": "b1cefab0-0560-4a88-b6a0-8e42f7029229",
"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": "44f28c32-a949-48df-b03b-c96afad7f71d",
"db_country_code": "sample string 28",
"feelist_id": "ee4b9f02-4ac8-4eeb-ad75-d83863738c50",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6f1a0ec8-4cf3-42ad-a6ca-74e02c48ffb1",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f1fbcf8a-18c6-4705-8618-afbd843fd006",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-05T14:30:39.713693+00:00",
"db_currency_id": "676eee4c-487c-4c73-b523-88188dd09dd9",
"db_currency_code": "sample string 10"
},
"company_type_id": "54c922e0-7040-48fe-b8ab-3353912ae65f",
"company_type_name": "sample string 32",
"company_type": {
"id": "72ee6634-26d2-4bdf-8f48-d3e153c0c0dd",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "556b2d93-3b06-4196-a687-9ba96e1ee8bf",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5e690436-eba5-41c3-aad7-c11e07e45f30",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "533a2445-7604-4345-9529-53a8473b3d12",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "180e6a2e-b210-48cc-88bd-3158387edc2d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "6cf54fef-1575-4da5-a81f-66d5cee08d42",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-05T14:30:39.713693+00:00"
},
"company_sector_id": "0a347bac-bf09-49ce-853d-47d515934698",
"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": "f3ed2d4b-6477-4258-acc9-bf77793b6ee4",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "eaafba1d-cc18-4106-852c-a39353ead13a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "19a7f348-0889-4015-9baf-4cc7cd92981e",
"account_manager_user_code": "sample string 56",
"company_status_id": "0cad0e76-e347-4315-adc2-3b52e9c1fd77",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-05T14:30:39.713693+00:00",
"id2": 60
},
"db_language_id": "3bec4cdb-6d77-44f5-ab11-24f96654de40",
"db_language_code": "sample string 7",
"db_title_id": "ea1d8fbf-98aa-48c4-a445-6873a6705e93",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-05T14:30:39.713693+00:00",
"create_date": "2025-12-05T14:30:39.713693+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-05T14:30:39.713693+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.