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": "6869eb96-28e5-4bde-a4f9-894585b32235",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3c55cccb-dc83-47a8-8210-0bcb9e81aa99",
"company_code": "sample string 5",
"company": {
"id": "625dea30-92ad-4aa6-8200-f59907d59892",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-23T11:07:21.4995802+00:00",
"sales_territory_id": "682419a6-1713-46f5-b9ad-da8502c08f26",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ce14ee1e-f56b-4248-ad0b-255cb8e378bf",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3ef01295-a144-4b08-af8e-e4953a9f7a12",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cdef70cd-d027-4be4-9a70-17fcfaa64050",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1f6fb59a-9dd4-40c6-84ac-d6cfb7deeae6",
"db_currency_id": "07fdc963-4e7d-4ce8-9dbb-8d7933855e73",
"db_language_id": "c38b94eb-20ff-4650-ba56-113729a172e4",
"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-23T11:07:21.4995802+00:00"
},
"modified_dateutc": "2026-08-23T11:07:21.4995802+00:00"
},
"marketing_segment_id": "558c98b5-592a-4311-8d58-b97b37810474",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "bd323b82-5383-4c43-bb0d-f6a2e6ef2beb",
"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": "d8815d87-4eb0-4fa6-bdff-18383e9474b8",
"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": "420b97ed-6676-4e14-bf40-34ab717a0602",
"db_country_code": "sample string 28",
"feelist_id": "eeb569b1-d5af-493a-bb1f-e231e13313c9",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3fa52c24-235d-41f4-9f16-16c8e18cfbf9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e36e7705-bbea-4cc0-81ad-b0a5cad119bc",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-23T11:07:21.4995802+00:00",
"db_currency_id": "f035f504-00b1-40ae-b933-495171d44855",
"db_currency_code": "sample string 10"
},
"company_type_id": "45527c1c-5ca6-4aa0-8a53-5490a936de5d",
"company_type_name": "sample string 32",
"company_type": {
"id": "4972d121-20e5-4910-becc-e3877629737b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1b9cce5b-926b-4040-9e76-2978464da240",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9f353fef-a28b-443c-a52a-cfbbfe492964",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7dec1a73-d703-4298-989e-a31774389f39",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "86f93e70-b835-45cd-a477-c094c65fe0ea",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "081e44ec-40be-4079-bd57-ca95ef5c09c1",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-23T11:07:21.4995802+00:00"
},
"company_sector_id": "4a741780-6095-4970-8629-abf42847e3af",
"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": "ff909e01-73cc-4887-8f06-5fc63daac49e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "6b9d1eda-d9dd-458d-ba6e-7f4d3fc81727",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "39ed8927-cc5b-4382-85de-7931040f6bed",
"account_manager_user_code": "sample string 56",
"company_status_id": "9271949b-b644-4435-98fd-43a4bf28ff29",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-23T11:07:21.4995802+00:00",
"id2": 60
},
"db_language_id": "43aee639-cefa-48cf-b633-8a6935bd5bc1",
"db_language_code": "sample string 7",
"db_title_id": "58caec03-f490-43a4-85f0-4376c1073c9c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-23T11:07:21.4995802+00:00",
"create_date": "2026-08-23T11:07:21.4995802+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-23T11:07:21.4995802+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.