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": "2e21f5b3-b5e6-42e9-8fcf-51fa8c692cfd",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "33e5d265-9cff-4ea3-9d31-cf4587f97451",
"company_code": "sample string 5",
"company": {
"id": "9b04dc5c-0b7c-4f7a-8b9a-096e2095be4e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-11T09:08:53.4153393+00:00",
"sales_territory_id": "724c71f4-d34e-42d8-83b6-83dd63e4a601",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f3dc2cc8-7b02-4441-b6b6-b2891d9eaade",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "42c5c26f-a798-498f-a7fb-4cd4e4bb5d14",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "24d6da0e-6202-48e4-877e-34ad691e97da",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17949235-0328-4a36-83e7-311cff5b4783",
"db_currency_id": "7e5f0919-5d67-46b8-974f-95a9479f8b08",
"db_language_id": "873334eb-ced2-4242-9cf4-d95bfe253459",
"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-01-11T09:08:53.4153393+00:00"
},
"modified_dateutc": "2026-01-11T09:08:53.4153393+00:00"
},
"marketing_segment_id": "39003a5a-26a0-4475-ae9b-24565d88cc85",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "dcac4cb9-be7a-4b68-a297-1020067869ed",
"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": "67f5f0de-2745-4a67-9492-29d04f963676",
"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": "fc62e7ae-cf40-4ab8-b74c-f050db167679",
"db_country_code": "sample string 28",
"feelist_id": "f36e45e7-0ac3-4a00-ac18-d289df96474b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e453a99d-d69f-4cd2-a774-7b407b24d773",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "3f2d91df-c600-4f59-975b-e61f0e427cc3",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-11T09:08:53.4153393+00:00",
"db_currency_id": "fd6d6009-ad81-483f-824e-e556de023f4d",
"db_currency_code": "sample string 10"
},
"company_type_id": "72b49a09-b77f-4497-b64b-0da53183397c",
"company_type_name": "sample string 32",
"company_type": {
"id": "5254a590-3ccf-4f77-af05-a96c90cb6f91",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d48e07d4-8710-4608-8dc0-55ef41d4b192",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ccdf124e-a659-4683-8142-dec79748e6d0",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3a062347-687a-4a6f-b7c4-e743e04687f2",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "9d16949b-56c5-4921-bd62-821abf428e76",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9e6c1d81-1a8e-411b-b2f5-5322d4361acc",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-11T09:08:53.4153393+00:00"
},
"company_sector_id": "642645f2-3bcc-4ecb-a0b4-ab8e95544564",
"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": "4720236a-ae97-41fa-9a0c-5d437a6df360",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7644fd50-4618-42ca-8c6e-fff89cb0d057",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "5c57d4fe-6b1e-469b-9a94-b89796362691",
"account_manager_user_code": "sample string 56",
"company_status_id": "5e0e8fa3-9612-475d-87ef-9a97059e57c2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-11T09:08:53.4153393+00:00",
"id2": 60
},
"db_language_id": "bb1b227f-6d1b-4d21-b00a-26019d5bdfcf",
"db_language_code": "sample string 7",
"db_title_id": "78929641-c6ea-4ee6-8f99-73c7b7fc97cf",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-11T09:08:53.4153393+00:00",
"create_date": "2026-01-11T09:08:53.4153393+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-01-11T09:08:53.4153393+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.