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": "dec29ec7-bc13-4d60-88c1-453989ba9b96",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "91920777-888d-4744-bf67-dfa7d0514c69",
"company_code": "sample string 5",
"company": {
"id": "d72bd3eb-cfe0-4cfd-b906-1408af321d07",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-12T21:55:01.30402+00:00",
"sales_territory_id": "1d9225c9-1c0a-48ed-9a4c-eafb01528430",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f4bed0bc-5917-4084-bcc6-2a821c5ef5aa",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "70f2e5f7-1982-433d-a884-05fd03da1dfd",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4fc60ff4-256e-4862-a994-4e567206b10f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "75265e43-5331-432d-b2f8-02b967dcccbe",
"db_currency_id": "b2efa70e-43eb-4c68-ac03-0d917b4691bb",
"db_language_id": "9e25c215-1b21-4f55-ab09-f93bb6183e86",
"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-07-12T21:55:01.30402+00:00"
},
"modified_dateutc": "2026-07-12T21:55:01.30402+00:00"
},
"marketing_segment_id": "e8e3a9d9-27e1-4abd-95a1-f648abe24c04",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d541b9b5-c910-4f06-aaef-964246010fca",
"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": "f2e16bdc-f0c0-45fe-8ae3-d2dd47d7ccbf",
"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": "578841a7-f905-45b4-9914-386d1ba421bb",
"db_country_code": "sample string 28",
"feelist_id": "173f3ef4-d0ed-4776-af2e-27a01f6f6680",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "fb5e1f15-6597-406d-a286-137659c764cd",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8890f732-9210-41ef-a901-386a66db432e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-12T21:55:01.30402+00:00",
"db_currency_id": "cffbb5a8-706c-4c1e-b067-bb0094bdbe2b",
"db_currency_code": "sample string 10"
},
"company_type_id": "41cc0df6-5703-41e6-993a-f8c379640c71",
"company_type_name": "sample string 32",
"company_type": {
"id": "8ee4cf8f-4f48-4496-a32d-768b2b4893db",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6e6f8742-a0fe-4406-ab27-a4b1588553a8",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d68b2489-baa9-43e4-ae26-9973e4747320",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6cd574a8-212b-4646-82f9-3fa02e6048ca",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "bb58e4fa-a644-4bef-9417-3918b006c7e1",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4d0e1c5b-d277-4ffc-b508-b8f0559ded69",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-12T21:55:01.30402+00:00"
},
"company_sector_id": "a403e645-43d5-4d5c-bcbb-8ac0843c2409",
"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": "280a581e-af1b-479b-a581-2b8985acea1c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a458f34e-dec6-4002-aa5b-9d2f8674f483",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "13a38936-2050-48c7-91ca-3213e87b729e",
"account_manager_user_code": "sample string 56",
"company_status_id": "1df02c03-19d2-4f0b-977d-9efc5ed93573",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-12T21:55:01.30402+00:00",
"id2": 60
},
"db_language_id": "7656907a-4b73-4123-ac76-bdd959650578",
"db_language_code": "sample string 7",
"db_title_id": "953b6f13-dc31-4b3b-98d2-a3e9c98a1391",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-12T21:55:01.30402+00:00",
"create_date": "2026-07-12T21:55:01.30402+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-07-12T21:55:01.30402+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.