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": "1855b11e-5755-429d-84be-6bc652fae252",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "20503835-4827-4c24-9bde-84cfa1895218",
"company_code": "sample string 5",
"company": {
"id": "54be5c91-354e-4a2d-8e00-034515d74725",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-22T14:22:20.4309964+00:00",
"sales_territory_id": "946b45a0-6110-4672-aa1d-c14c5513293f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7d442066-e0bf-4430-803b-b539dff46c38",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7bb1d4fa-10dc-4b0d-9c83-7407e4b0da2d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cf2b3309-3664-4180-ba33-f54165031428",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cb1bd056-9ba8-4f9a-99fb-9979a6f0e6b9",
"db_currency_id": "f7eecc07-a670-46bc-b395-8fadf6fca462",
"db_language_id": "52968d6d-f151-4b75-9dbb-7a5a6d1e9f37",
"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-22T14:22:20.4309964+00:00"
},
"modified_dateutc": "2026-07-22T14:22:20.4309964+00:00"
},
"marketing_segment_id": "b949053c-052a-4738-9577-1ab53627724a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "17a6baaa-37f1-439b-beb9-d368d950094a",
"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": "be01c747-5afe-4828-917d-7111cb3e4c36",
"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": "56450360-7d0d-4e6b-afe6-0b5687e95a96",
"db_country_code": "sample string 28",
"feelist_id": "819f1a91-5bd3-4037-b131-4ad516ecd2e3",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "dd9c6425-0788-4f4d-9577-19b7602ef639",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f21d4095-0546-47d4-8090-3f25b6cc5a9c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-22T14:22:20.4309964+00:00",
"db_currency_id": "a4f91ff8-229a-4c0d-868f-55427e9106c9",
"db_currency_code": "sample string 10"
},
"company_type_id": "401e9791-fa29-45bd-8c32-e7279a73f9ec",
"company_type_name": "sample string 32",
"company_type": {
"id": "1ffa3f82-7c71-4373-b51e-a268cddeb319",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ac600e41-52ec-41e8-9412-195e6412f81e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "fb6b76bd-4558-48d9-a3f6-0c233595f168",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "dcfc60d3-10a6-4287-8675-4eea19ff2ff8",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0d166329-8b63-4b47-81cf-afe14f0b9c77",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d0926ac7-e408-4fb9-bb01-5416b6776ca9",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-22T14:22:20.4309964+00:00"
},
"company_sector_id": "5005a15a-f06d-4cae-ab04-b1533726c6dc",
"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": "7c0212ae-83b7-422c-a18f-b22ffe78925e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "05d8438e-8afd-4e87-9aaf-218acff07591",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0e9c0d7d-1f9d-4961-823c-61e0d00554d1",
"account_manager_user_code": "sample string 56",
"company_status_id": "679966fe-741b-4b04-b6a6-aa78fa5bf853",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-22T14:22:20.4309964+00:00",
"id2": 60
},
"db_language_id": "ec25293d-5cff-4180-ae52-7760a6a9d7af",
"db_language_code": "sample string 7",
"db_title_id": "67076687-4178-4a96-8a7c-ecc9f3d95d89",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-22T14:22:20.4309964+00:00",
"create_date": "2026-07-22T14:22:20.4309964+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-22T14:22:20.4309964+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.