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
{
"id": "877c0b9c-ad3f-4437-ac4a-93de7df60f1c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8294f1c8-57da-43b8-b004-29692773be4f",
"company_code": "sample string 5",
"company": {
"id": "3b2a1c5b-bb0b-4f6c-a049-9437270766be",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-20T17:15:48.3744832+00:00",
"sales_territory_id": "62e015e7-a974-490a-b8ad-7cbffc7c83f7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "606930c0-af3e-4e40-9e2b-b5c7cec9dc2d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "31e7ae83-d14a-4eb4-bf88-c5f2aec08bc8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "63d3d548-367a-474b-be79-7611d04564b9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "512c9ae2-ef43-45a1-bfa4-4d2dd1ba73a4",
"db_currency_id": "a9cd460b-36bd-4993-9edb-bdb25e90d490",
"db_language_id": "ae5456e9-48a9-4df2-b0d7-9b511832ec14",
"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-11-20T17:15:48.3744832+00:00"
},
"modified_dateutc": "2026-11-20T17:15:48.3744832+00:00"
},
"marketing_segment_id": "e9fed0ef-55e7-4e16-a8c5-710797aa3856",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "05d396cb-4ec5-4c04-9b51-f40d2896a10e",
"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": "b15d5a1c-e650-4020-ad25-0c370f8d7e1d",
"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": "cd92026f-5f2f-422f-b019-696a576ae4bb",
"db_country_code": "sample string 28",
"feelist_id": "442ed35b-6a39-40b8-bb55-0ec5d17ffe76",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "57860321-c05e-4cff-b030-a20aa9842fd4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b19ed305-9127-4962-ac5a-e9f6186c14ef",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-20T17:15:48.3744832+00:00",
"db_currency_id": "01681824-3ac8-4ab8-b95e-6afaa61bf692",
"db_currency_code": "sample string 10"
},
"company_type_id": "07557af1-bf65-45ad-be3d-c808707960ec",
"company_type_name": "sample string 32",
"company_type": {
"id": "438fb5dc-d07a-4bb6-bd92-a8d6dd56a230",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "71afe58b-be9f-445e-b9c1-302a88cb97f6",
"sales_organization_code": "sample string 5"
},
"db_language_id": "badabd0e-aa64-4ba8-9b6a-ac37710ea27b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e4341114-a361-49e2-bdbc-943370f01093",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "12b98df8-4b26-409c-94d9-8f07e1d38a51",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c0b96249-a28b-4b15-a26d-3f5d06530eda",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-20T17:15:48.3744832+00:00"
},
"company_sector_id": "7e082b35-462f-4287-99fc-6f08cfed3fc2",
"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": "b50a1f78-e3db-455f-b09a-656fc10eeb7d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ce09affa-60b5-478b-93df-f3fa5ed54709",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3ada8ec6-008d-4ecf-a0dd-9d8ccd045434",
"account_manager_user_code": "sample string 56",
"company_status_id": "19404e7b-778e-4a3e-9f2e-0f95aedecb2a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-20T17:15:48.3744832+00:00",
"id2": 60
},
"db_language_id": "ec38d857-40e9-4ed5-8f01-d2be40f3cc8a",
"db_language_code": "sample string 7",
"db_title_id": "7dc8c38f-3e75-4d27-8926-672404d1e634",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-20T17:15:48.3744832+00:00",
"create_date": "2026-11-20T17:15:48.3744832+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-11-20T17:15:48.3744832+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.