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": "470fcdec-97f7-421c-9fc5-902e9c5324c1",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "11f2c4f0-9a8b-4b85-bd02-b952d4c38004",
"company_code": "sample string 5",
"company": {
"id": "709f78a3-d2b3-4e29-a8ff-2e49d930ae94",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-18T11:06:47.5202897+00:00",
"sales_territory_id": "97ea4cb3-d494-4fbd-a749-adb807ce0438",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "adbc2854-5c1f-46e4-b3bd-865a367f0446",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "02b5112a-d77e-4e88-817e-d22dc60e96db",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8eb31f4e-6056-4fbc-a6b2-83e3c034851a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9a85df09-ded3-47c7-8a70-14836a3b7ade",
"db_currency_id": "2c6cab22-8557-4c51-b6ef-15ca2af2a60f",
"db_language_id": "336888f5-323a-4bc1-9e9c-f298fc34d582",
"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-02-18T11:06:47.5202897+00:00"
},
"modified_dateutc": "2026-02-18T11:06:47.5202897+00:00"
},
"marketing_segment_id": "5490c942-05db-4360-8a2d-946937c7e58d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3c67f4aa-125e-4a57-9aba-c77cc2f7efed",
"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": "a8a7c614-069e-4a50-85e7-227e8895b01a",
"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": "7a029237-883a-4e75-8177-943303cc05eb",
"db_country_code": "sample string 28",
"feelist_id": "80ef08be-4159-4514-bec9-e2bede2c6859",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4593e6c8-ec1b-46d1-8697-e1ec785dd430",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a77a7d15-536a-48a1-a9ae-a2a172aa49b9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-18T11:06:47.5202897+00:00",
"db_currency_id": "165c3660-9af3-41f9-960a-a78c39e53b25",
"db_currency_code": "sample string 10"
},
"company_type_id": "5175931e-d4ee-405f-942c-c188123e8427",
"company_type_name": "sample string 32",
"company_type": {
"id": "4bab971a-6815-4417-bdd4-32092c7c81e6",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "81729c81-a826-40b4-b6d2-c93ada510f43",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8c37cae6-abb3-4fda-847f-827e3d4df936",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "df028938-2e6a-4237-936a-61423f426a43",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a40ca7b0-b189-4f27-8fb4-a611dcc1b5e4",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "790baff9-d394-4f19-b655-8a2f35a226ba",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-18T11:06:47.5202897+00:00"
},
"company_sector_id": "63e40752-8c2b-400f-b96d-e4e734b548bf",
"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": "7287f1d3-38a0-4953-8210-e483ad39aa55",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "744dbceb-5d1d-4169-ba98-7222b662610d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "98234ba9-1506-44b3-b2ac-b2e90b9068b9",
"account_manager_user_code": "sample string 56",
"company_status_id": "cf7829c3-5f70-46df-95a0-5160b8302788",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-18T11:06:47.5202897+00:00",
"id2": 60
},
"db_language_id": "771b55c5-602c-40f7-8955-b3302e4987e8",
"db_language_code": "sample string 7",
"db_title_id": "a3adad81-fd21-40bc-8ed9-2b3a76dd72b1",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-18T11:06:47.5202897+00:00",
"create_date": "2026-02-18T11:06:47.5202897+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-02-18T11:06:47.5202897+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.