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": "7b18e075-0e69-48a8-a3b5-a2e9d1d5078b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d6073eb3-6412-4b36-b427-a5156f356959",
"company_code": "sample string 5",
"company": {
"id": "37cd0862-5121-44b0-bc45-e038a5bd1c3e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-04T03:14:06.7611948+00:00",
"sales_territory_id": "c983aa46-74ea-429e-abd9-ddd84f3df8f1",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "dce5d404-21b3-42b1-bec9-71cde4ba3eed",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bfc64055-86fe-4c41-9861-549733e6d2d4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8059dfd9-3d32-4b31-9bad-7fbc614aa147",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "feea8a60-84c3-4ded-b159-2345859eb933",
"db_currency_id": "61a8f5c4-3d12-4c6d-be20-b09f41420d3f",
"db_language_id": "4151415d-9100-472c-97ed-4175e9a50dee",
"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-04-04T03:14:06.7611948+00:00"
},
"modified_dateutc": "2026-04-04T03:14:06.7611948+00:00"
},
"marketing_segment_id": "a25940c0-2d42-477d-953d-46118de5b41e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d34c7f90-2955-442a-8ca3-fc6e534a0a51",
"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": "1ac5d4b1-a8b3-47bf-a77d-8dfa3cc88be6",
"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": "60e01edc-c587-46f9-88b5-e54b98898cc0",
"db_country_code": "sample string 28",
"feelist_id": "c1534f16-9e1e-4fa9-81d7-71c64ec727a8",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6c42247c-ce43-4433-96c5-b4eb94de8fac",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5db6fd18-0e18-4110-b0db-0940142b4331",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-04T03:14:06.7611948+00:00",
"db_currency_id": "c33a74e7-5960-48fe-a6c2-f439533ead80",
"db_currency_code": "sample string 10"
},
"company_type_id": "3d9aae34-98c8-4bc1-8fa0-82142a708213",
"company_type_name": "sample string 32",
"company_type": {
"id": "f4392f9f-dd01-4e5b-bb1d-dae8d523d949",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "baebad9a-a98c-46cb-843f-459c847034fd",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2dcb3b30-475d-4ed5-9a33-033d6826c8e9",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "323670db-ca55-4f88-abac-27d467d5b8b4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6c89384a-3b6f-467b-878b-21cbc3f4859f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ace1ec4e-4bfa-456f-91eb-6a43d2bd95f9",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-04T03:14:06.7611948+00:00"
},
"company_sector_id": "2785b7e2-f81c-4cde-903b-578c76f0a671",
"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": "4e04b159-7150-4900-9fd5-f440796a494a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c71df85f-0720-42c5-835e-aa5b2e8e2d80",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "1fcb6627-cb79-408c-95cf-c718a94164cb",
"account_manager_user_code": "sample string 56",
"company_status_id": "75314495-7ffc-45fc-82c5-770a04648f45",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-04T03:14:06.7611948+00:00",
"id2": 60
},
"db_language_id": "1b4f054a-3a74-4c6b-ae63-87dd9707a251",
"db_language_code": "sample string 7",
"db_title_id": "34f8982e-db59-4d92-a2c2-63db1541da11",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-04T03:14:06.7611948+00:00",
"create_date": "2026-04-04T03:14:06.7611948+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-04-04T03:14:06.7611948+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.