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": "3e22abd7-edce-4fe6-b3ea-e0d0562c41a4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3f910308-05be-4455-bc2f-32009e870c13",
"company_code": "sample string 5",
"company": {
"id": "3d3650af-9bd9-4533-a549-e985522604fa",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-14T10:00:35.9136958+00:00",
"sales_territory_id": "b1ce871d-0820-4578-a860-55c29a307b50",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7e5f9126-8261-4d14-84f7-a35ea73f42fe",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6fd7b615-abc6-4158-bcd4-77b2f394f692",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b4d92b5f-ee45-41ca-aec1-dfccbc6dc2b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dd3de140-05e9-4e7e-9136-55b1c1b60596",
"db_currency_id": "7c4fa55a-210c-4b6a-adae-ebe7082f1e89",
"db_language_id": "6dbaf425-5234-4bab-8151-81f520e940a8",
"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-09-14T10:00:35.9136958+00:00"
},
"modified_dateutc": "2026-09-14T10:00:35.9136958+00:00"
},
"marketing_segment_id": "7bdede6a-f2cf-453c-ad8a-6ab9b459dbf5",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "410d6bb7-b439-4756-be1b-8833f8bfc510",
"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": "04e3c213-f13b-4b4a-8b75-4f79477f7294",
"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": "52cb8967-9037-48b2-8431-d632f9b02c08",
"db_country_code": "sample string 28",
"feelist_id": "d69affae-ac7f-431f-a20b-3d8e6c0b1117",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "35f6810b-d54f-4844-91cf-c930488591a5",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "3c3d8f3e-c5fb-4039-8ceb-fb6b8e2d912c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-14T10:00:35.9136958+00:00",
"db_currency_id": "4db7f81e-52df-4d64-8bae-75403937d10e",
"db_currency_code": "sample string 10"
},
"company_type_id": "264c55e2-acde-430b-be55-c684259cee51",
"company_type_name": "sample string 32",
"company_type": {
"id": "6e54c6a7-fd91-417a-b113-c89e26041834",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4966ed2f-d6d8-4f1f-964f-f754e610b721",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3afb6cb4-8cc4-4b3f-be50-07d8e470171c",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "24522a9a-4cd7-4d88-9220-87b0ac4ca3e1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "82911eec-c566-40d9-9d05-d94a3b086197",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d5793dd6-7ca4-445a-b4bb-4feb829040dd",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-14T10:00:35.9136958+00:00"
},
"company_sector_id": "87f0d427-8439-472b-9f55-4231109ac949",
"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": "608bc758-e7aa-4282-9981-45fe5d592fa9",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9069b0d1-6fec-49f5-af01-30ccef1098a0",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4e22c079-91bd-46a4-b356-04d1fccc3e9e",
"account_manager_user_code": "sample string 56",
"company_status_id": "4e21a031-97bb-4fb1-b4ee-b913ca9cd513",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-14T10:00:35.9136958+00:00",
"id2": 60
},
"db_language_id": "2af70532-9035-493b-abc3-9d30d087e4a5",
"db_language_code": "sample string 7",
"db_title_id": "e16e5822-8b50-45a8-8968-f6fb1bdf524c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-14T10:00:35.9136958+00:00",
"create_date": "2026-09-14T10:00:35.9136958+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-09-14T10:00:35.9136958+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.