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": "e531b08a-7652-432b-8bb9-42a9cff4a775",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "5413c1fd-cbd2-4833-8b6b-2569eb4d1a12",
"company_code": "sample string 5",
"company": {
"id": "f6c1f3af-6275-4a34-99e3-9d31fe33cd26",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-08-11T10:29:06.049679+00:00",
"sales_territory_id": "33c27b70-50da-4010-894f-e5fcf720a853",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "87b8030e-4cce-405d-9e30-5dd2aa64fc58",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e5128a14-e749-4a3d-9c33-028e9b8d94a8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "58fcfbc6-f796-40e8-9eba-26b32de9e2ef",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e0f33561-4e94-4f00-9ae6-f6cfd79d091c",
"db_currency_id": "3b198cb5-cbad-43e5-ae87-9e455e41fedf",
"db_language_id": "075854b0-f33c-4858-b68d-171e090f2ab1",
"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-08-11T10:29:06.049679+00:00"
},
"modified_dateutc": "2025-08-11T10:29:06.049679+00:00"
},
"marketing_segment_id": "4fb36868-160d-4015-93ed-a9919fcdc789",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d78b97ef-1bbf-40ab-b20f-832a6a3f6739",
"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": "c4dc8d3a-a4ca-4445-a792-ea1a03050dbc",
"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": "e0d38f23-2c63-4301-b0b5-e71c1fa4da58",
"db_country_code": "sample string 28",
"feelist_id": "bb114089-9bfa-4cfd-a740-f6c315e5d5cb",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5b27aafd-dca8-4fff-bac7-a38624495590",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "9000ec6f-0ca6-49e8-9772-f2c19813b4e6",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-08-11T10:29:06.049679+00:00",
"db_currency_id": "b54d3ec3-205d-487c-8bae-c3773f2a07a1",
"db_currency_code": "sample string 10"
},
"company_type_id": "81a82362-2d9b-4753-93df-0fd6a56e1215",
"company_type_name": "sample string 32",
"company_type": {
"id": "590ead1d-cef5-4711-9cfa-15d9a0dde9a4",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "197be563-ecb9-4da1-9d1e-335899df2416",
"sales_organization_code": "sample string 5"
},
"db_language_id": "39082257-f506-4ae1-b805-7b58693ea5c3",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "71418913-cd4d-44d0-aefc-144aa0851d05",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "92aeb0a7-387b-4591-991e-6023bf8340e8",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f95240ff-22c9-4c49-8aa6-856057c4bba2",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-08-11T10:29:06.049679+00:00"
},
"company_sector_id": "fbcddb74-e001-4314-8642-9d233a91d0d1",
"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": "2e367204-3871-47f2-9797-d8eedcf2f7b7",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0e8fdf9f-fb80-45c8-88bb-95b3cc8e3c07",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "1841a59b-6b94-47cb-9385-1040fb4b3d40",
"account_manager_user_code": "sample string 56",
"company_status_id": "7a3a6dff-d907-4912-9f2b-75dde2595a73",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-08-11T10:29:06.049679+00:00",
"id2": 60
},
"db_language_id": "5b5064ee-63c4-4869-a6d6-cfc31a8d02fc",
"db_language_code": "sample string 7",
"db_title_id": "cbb90768-8077-480f-9d9b-62f41e8d97b9",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-08-11T10:29:06.049679+00:00",
"create_date": "2025-08-11T10:29:06.049679+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-08-11T10:29:06.049679+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.