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": "d3f36eb7-31b7-47a3-aa04-00ff35dc8d1f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1e23f0a3-0054-47b9-91df-87f2be29f48e",
"company_code": "sample string 5",
"company": {
"id": "ec1ee3a2-9dc8-44ed-82e3-8cb3391abf1a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-18T00:26:01.2601666+00:00",
"sales_territory_id": "2791c98b-cddc-4182-bb97-b04ea588e67d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b36eb1fa-d2e2-4c0e-9bd7-2438c3ee9aa8",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9bae55c8-fe4c-4d7a-8822-49c46c4eb633",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b2c1daa9-0284-45d1-bdca-c256a3f8d72a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4a6155f7-8e6f-4be4-b66f-d85d1e0bf22d",
"db_currency_id": "94c7d68c-9c62-42b3-95fa-d1effb5b427b",
"db_language_id": "a3145619-7be7-4118-82ba-f47bed68ed35",
"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-18T00:26:01.2601666+00:00"
},
"modified_dateutc": "2026-04-18T00:26:01.2601666+00:00"
},
"marketing_segment_id": "d6edb627-cdc9-4e8d-83cc-7162601c711d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "02db88b8-f315-4ad2-a923-8d923e572af9",
"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": "59c3a162-5b0f-40e1-a2ab-8da0983592df",
"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": "2a69f231-5a3b-475a-b27f-01ebefc20f4a",
"db_country_code": "sample string 28",
"feelist_id": "93c59cee-bda2-4b87-995c-defe9eeda163",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "fb1b48a8-89cd-4165-8e1e-31cc1788e53f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "34e21ac0-7dcc-41b0-a7af-ec99e34c2ea7",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-18T00:26:01.2601666+00:00",
"db_currency_id": "4b91db52-f40a-4854-9118-b4e9a33ef849",
"db_currency_code": "sample string 10"
},
"company_type_id": "c60c743e-bef0-4a59-8372-8c12663fa3e1",
"company_type_name": "sample string 32",
"company_type": {
"id": "62afa809-6e8e-4e78-b5b0-a4ca24ef6091",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fe3db6cb-db0c-4cb6-8324-6637f5475734",
"sales_organization_code": "sample string 5"
},
"db_language_id": "4a9eba4f-0936-450f-8f29-b90cdaadab87",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3475ec8f-6993-4bf7-bffa-f46f9d931a6b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c961f30d-db87-44bb-b1ac-927ca7dd9dd3",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "24539e1c-672c-4d1e-afd8-b683ba7b67f0",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-18T00:26:01.2601666+00:00"
},
"company_sector_id": "c275ca7b-b48b-4f36-ac03-78c31aefa1d9",
"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": "d4e6e678-408c-4c41-88b1-338547beb63c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "16b5506f-df96-44d2-a59c-2757fa1a9a8c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "389f4430-567a-4397-ac2a-59afc20d058d",
"account_manager_user_code": "sample string 56",
"company_status_id": "985d4aad-fe85-4b2e-a37d-0596a0109860",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-18T00:26:01.2601666+00:00",
"id2": 60
},
"db_language_id": "3eb3a097-8097-4dda-9b0b-eab28512d0ab",
"db_language_code": "sample string 7",
"db_title_id": "c92029a4-8d3c-41a2-88ec-572d311127d4",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-18T00:26:01.2601666+00:00",
"create_date": "2026-04-18T00:26:01.2601666+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-18T00:26:01.2601666+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.