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": "aae353a3-2bc6-4cd7-8879-e31bd4f61652",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "77e1cc21-e9fa-4d9d-b0ae-a8e0accc2f6c",
"company_code": "sample string 5",
"company": {
"id": "3884647a-a683-4202-ae3f-44824d003df8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-23T20:46:29.9741292+00:00",
"sales_territory_id": "9e82fb21-f004-4107-81b1-ece16a36770b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "140284ce-f20c-4cd0-b103-b0aa1f4d0ba3",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "80b6b72a-9f59-4706-95ce-5f0590867f7c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b5f1497f-bcb3-475c-a6df-8fa558d8f173",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "21046444-78fe-410b-bfd1-009ff4edaa62",
"db_currency_id": "2144d21f-ab41-460c-99ad-bd5ea36d4db6",
"db_language_id": "2fea32d2-b69f-44fc-b0ed-003c88994069",
"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-12-23T20:46:29.9897537+00:00"
},
"modified_dateutc": "2025-12-23T20:46:29.9897537+00:00"
},
"marketing_segment_id": "8d745edb-442c-457a-9e1d-a17c4ec98b67",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d4f4ac5b-1b96-4039-893d-0a8d5c393a2b",
"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": "b6837f7f-b55b-469d-8200-fb2b09b3f4e3",
"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": "842ce87d-1a8e-43fd-aa9a-7249be77d403",
"db_country_code": "sample string 28",
"feelist_id": "a4e6f10b-f302-4134-b6bb-f2e463fcdf2b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "75def093-386a-4c74-b8ed-39c244fe7114",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "3a463192-eb28-4e9f-bf33-f5aba2f4890c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-23T20:46:29.9897537+00:00",
"db_currency_id": "d7fe2799-a31d-4275-9472-a7cb4e602f42",
"db_currency_code": "sample string 10"
},
"company_type_id": "3dcf8894-4396-4867-901e-7ffdc0377edf",
"company_type_name": "sample string 32",
"company_type": {
"id": "16e5f338-4df0-4d8b-9f25-68a8e8aed832",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0f47b7dd-f1c9-4706-8ae5-5560d1c06be3",
"sales_organization_code": "sample string 5"
},
"db_language_id": "076df43f-4885-41aa-92a3-44baaa85e463",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "09b1dc47-1112-4e19-a50a-0eb02b95f9a9",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "20baeddd-43a1-4386-9693-9dac72be01c7",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "6831acfe-cb0a-4576-b5e9-6b4aa35d649d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-23T20:46:29.9897537+00:00"
},
"company_sector_id": "8ff08ad1-ff76-431e-adab-300c3d92b590",
"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": "db66c1c8-ab74-4e71-8054-ea6ba8f061c4",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "860b5bde-6e67-4a04-b81d-4779ac98801b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "05c6e68b-c013-4514-adc0-0fc7a1f8c156",
"account_manager_user_code": "sample string 56",
"company_status_id": "51cec9c1-8535-448f-9358-086acee85694",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-23T20:46:29.9897537+00:00",
"id2": 60
},
"db_language_id": "cee98849-4ca0-49a2-a05e-8d2d56b80969",
"db_language_code": "sample string 7",
"db_title_id": "d7ccf616-1b3f-45b2-8946-797bd99a5a47",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-23T20:46:29.9897537+00:00",
"create_date": "2025-12-23T20:46:29.9897537+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-12-23T20:46:29.9897537+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.