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": "33e9f4d3-2ef4-442f-970e-0142a71951a0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d757ebfa-3511-4751-a822-8381e673d31b",
"company_code": "sample string 5",
"company": {
"id": "ba03f2bb-dc35-4e85-82f0-04f2a19c07fb",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-05T08:12:21.3978732+00:00",
"sales_territory_id": "ae4fe521-ffa8-44d4-b840-95a6fa1cd073",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8144d179-2639-45f3-82f7-4f7f4b307fee",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "265f7fc3-ffe3-42fe-bc0e-1b6e07ca63ba",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "614e436d-eff2-485d-9578-85684f2f0dfd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dfb8b731-3258-4ebb-b9b6-dcc774b4400d",
"db_currency_id": "95d486fd-8794-442f-b84f-dec082a515af",
"db_language_id": "992cdfbd-ad92-421b-a822-7d377ca0efdc",
"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": "2025-10-05T08:12:21.3978732+00:00"
},
"modified_dateutc": "2025-10-05T08:12:21.3978732+00:00"
},
"marketing_segment_id": "4fa4d2e0-5e36-405c-a521-55f8edfe1ae1",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "82d952ce-541f-4dba-97e6-5eb549660ff7",
"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": "b806b85a-c335-4274-b55f-2537c827f1a6",
"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": "6914cd1b-f9fd-425a-bab4-56591daf9202",
"db_country_code": "sample string 28",
"feelist_id": "0a9f647d-09f9-468b-a797-5ffd1f51d106",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "620c1cd4-f9d3-401a-8655-c1664d1c8f11",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "096eada6-738a-4b97-a777-d49eb07be78c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-05T08:12:21.3978732+00:00",
"db_currency_id": "58331473-72e3-468d-be0f-81bef185a82f",
"db_currency_code": "sample string 10"
},
"company_type_id": "2dea8284-9bdf-4e40-a5f5-1575a74a2955",
"company_type_name": "sample string 32",
"company_type": {
"id": "9033265b-4c16-49ee-b2ca-20c073e7acfd",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "aa5428b6-58bb-4bb6-a66c-1a507f694a12",
"sales_organization_code": "sample string 5"
},
"db_language_id": "25d2cd74-7c46-4d23-8728-51e5f60e398b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f021b58f-4515-44cc-873c-4a46cd20a339",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "420a51dc-247a-4976-ab7e-6e5504fb3022",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "6898bff1-4698-4ed7-8440-5ac860bc03a2",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-05T08:12:21.3978732+00:00"
},
"company_sector_id": "b9024968-17c5-41f0-9d4d-6b99eec5ff12",
"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": "44166a97-f897-4b08-a2ca-0779f04f0561",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "44d15950-9d12-4d55-9244-cfdc2da89e3b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "db054393-f283-49b0-b72b-9190ca6000e6",
"account_manager_user_code": "sample string 56",
"company_status_id": "cc30e20a-29f9-47f3-bf37-fc1cb3e01491",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-05T08:12:21.3978732+00:00",
"id2": 60
},
"db_language_id": "170e3f90-6139-4b2d-b335-3a10e386a9ca",
"db_language_code": "sample string 7",
"db_title_id": "fd48f307-2a5b-4b81-a015-b734525dab98",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-05T08:12:21.3978732+00:00",
"create_date": "2025-10-05T08:12:21.3978732+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": "2025-10-05T08:12:21.3978732+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.