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": "aa15da6c-1513-4ae5-9445-82be97680806",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "30dc2ba9-3579-4693-8df6-b539d6e8e28d",
"company_code": "sample string 5",
"company": {
"id": "bce2b114-ad36-4300-8a88-ace8b1c386a7",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-08T03:43:02.361079+00:00",
"sales_territory_id": "174923dd-bdea-4b0d-96f2-d299c57f232b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "50c4f480-3ba3-421a-a5da-fdb0c0d59e8d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b0c725a0-d402-4c2f-9b11-0a563e449027",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "84ecc606-8111-4402-997d-228020b2dfbf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "966bdcac-3e98-416f-a3fc-e7e5b9f58422",
"db_currency_id": "39568b4f-cfdf-4a80-93fd-d443074fac56",
"db_language_id": "4d444747-cfb3-4d7e-b7a9-f34672ab8558",
"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-08-08T03:43:02.361079+00:00"
},
"modified_dateutc": "2026-08-08T03:43:02.361079+00:00"
},
"marketing_segment_id": "e3ead2fa-aa80-4c92-922a-729365b6a1a0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6b8bad5b-cef8-462b-9c64-ef5c803f8345",
"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": "2446347d-71b1-4dbf-ae03-c8bee2b8a440",
"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": "50782035-b296-4dac-a2c5-dcbc3edbb7dd",
"db_country_code": "sample string 28",
"feelist_id": "ffa84380-621f-4a82-85ba-f08fa8c84e8a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b79bc234-7845-4507-a813-fe74b7b81459",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "3ab66c17-b90b-4e7d-8987-a9862238a219",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-08T03:43:02.361079+00:00",
"db_currency_id": "49f0c5c1-3319-4e2c-8a50-2b49699fc4cf",
"db_currency_code": "sample string 10"
},
"company_type_id": "e554abb7-e98d-407a-b642-44789014ba27",
"company_type_name": "sample string 32",
"company_type": {
"id": "8e8cd68c-f65b-4597-99bf-63ff491afec3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "369f6a95-3350-4947-b342-1f356576014b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b24c353e-2ebb-457f-bd77-71c60e6e3a10",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c6cdbf03-5f43-4307-abf1-c5435cd7edfd",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ebd6c287-ace2-4195-a845-8cde01fc5613",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "77a2c6e2-bf57-4a4f-a1ad-2b48630ad13a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-08T03:43:02.361079+00:00"
},
"company_sector_id": "34e3efda-15a3-4ab9-9c7f-93cdca442529",
"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": "d1b81e71-6847-45ca-a9ec-2fe9a305cd18",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b9fc9ab3-cc40-47e9-9ab2-f69633802cc6",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "2587c1fd-2c61-45b4-a364-e518208766cb",
"account_manager_user_code": "sample string 56",
"company_status_id": "27a07196-dba0-4c6f-a090-68f1ca687006",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-08T03:43:02.361079+00:00",
"id2": 60
},
"db_language_id": "cf3c2284-2bdb-4c6e-86f2-59ecd7194c57",
"db_language_code": "sample string 7",
"db_title_id": "d4647ba1-e80e-4660-bc19-8c3b675f0083",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-08T03:43:02.361079+00:00",
"create_date": "2026-08-08T03:43:02.361079+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-08-08T03:43:02.361079+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.