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": "68370ba9-b3d6-4126-a1e4-449311410f23",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ef5b45d1-c3f0-4cbe-97b0-a4e017f29fb5",
"company_code": "sample string 5",
"company": {
"id": "6401031e-e927-4704-b7ea-e3bf62535e11",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-16T16:13:21.2960963+00:00",
"sales_territory_id": "1eed1333-1af1-40c5-a5e8-96d0379f86eb",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9e679eed-53ab-427f-925f-f0daee97801e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "dd955e61-13b0-4d35-8d58-40d0339c7f34",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "be1e0b65-2c3a-45a2-88c3-1a463f8263e3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1a653a9d-2c14-4706-a06b-8089edd5623c",
"db_currency_id": "ce2c3070-05cb-4706-962b-39c55b04a100",
"db_language_id": "ffff172d-31a7-4efa-b67e-6aace991c3f7",
"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-09-16T16:13:21.2960963+00:00"
},
"modified_dateutc": "2026-09-16T16:13:21.2960963+00:00"
},
"marketing_segment_id": "330cc53f-e5e9-4ca0-aa28-05573d7a3e25",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6aee4a07-c218-4503-85b1-4a7ac3c58c66",
"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": "25bed77a-4883-4c51-b8e7-8fd861f31e41",
"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": "93674787-209f-4f85-9718-a6c1e4518636",
"db_country_code": "sample string 28",
"feelist_id": "54d7aa23-bf51-4e75-9bd9-e6b73d212b10",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b8a003a2-df6e-4617-9581-72e8aed7bb1b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "98bdb152-24bc-4ea8-93cb-2c25479bec00",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-16T16:13:21.2960963+00:00",
"db_currency_id": "14bd3ec2-3f3b-46ed-a874-43a277363a1c",
"db_currency_code": "sample string 10"
},
"company_type_id": "f5113e5a-cc22-47fb-88eb-443bf693978e",
"company_type_name": "sample string 32",
"company_type": {
"id": "24344a16-0794-486a-8ee8-1d7f60e4781e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2614edc5-34c0-41f8-a1b9-cf436a5bcc3e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "57de06df-daef-4e3f-858d-93a6c50b02ae",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a9c43cfb-5b51-4e7a-bfbf-b077af725f1d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c98fcfcf-658c-4e6b-9789-e04784761786",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "935e0ab9-89bc-4471-96bf-95f2f05c5c92",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-16T16:13:21.2960963+00:00"
},
"company_sector_id": "3daf0852-0ecc-4861-ba4d-56b2f42ada79",
"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": "5067121f-742f-4076-8eca-c03d36e6eb43",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9f066e95-77cf-4b06-bcf6-2b5a870d6723",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "06f56f4e-6826-413a-a6eb-2a4fabdf64f2",
"account_manager_user_code": "sample string 56",
"company_status_id": "036f3a78-86c9-4843-ae7c-30db8fbabd37",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-16T16:13:21.2960963+00:00",
"id2": 60
},
"db_language_id": "f741bbde-271d-43c2-bae6-3f9fad71af45",
"db_language_code": "sample string 7",
"db_title_id": "50117b61-79c4-4cbf-8f2a-5b9dcbd376af",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-16T16:13:21.2960963+00:00",
"create_date": "2026-09-16T16:13:21.2960963+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-09-16T16:13:21.2960963+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.