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": "ec56bf77-6919-49c8-b396-6610dffb0ca4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d4319add-3495-42dd-beee-595720affdcb",
"company_code": "sample string 5",
"company": {
"id": "e93dbce5-f47a-4e1e-abe3-345a18256a98",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-28T02:39:02.1459969+00:00",
"sales_territory_id": "bea75f9e-2c59-408e-8f12-2d31e585852d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "686b3490-2ffc-4542-b096-24d2393e1b19",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ed1f7f02-3f04-4d96-9826-89f5e5a1ad99",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2bdaa5ec-0bd4-4ed5-9259-ab510979e709",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d9b6cad5-5740-44ec-a03b-4a09609972ee",
"db_currency_id": "ec399144-a3a1-45c8-9221-49ecb008b6ed",
"db_language_id": "b7c1a032-0aee-40ca-9113-f95e6cf2147b",
"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-28T02:39:02.1459969+00:00"
},
"modified_dateutc": "2025-12-28T02:39:02.1459969+00:00"
},
"marketing_segment_id": "e094d336-7274-4ef4-b32b-da52d1bf8f08",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "82930ef3-fa18-4b21-9fc0-ea13b95e9dd0",
"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": "45673c59-ac2b-4483-ac9d-e4011ec4f977",
"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": "9c52cc37-db94-4203-918e-e23acf5050ad",
"db_country_code": "sample string 28",
"feelist_id": "39a2b3be-05fd-4b5c-9d36-21e8b39d7dac",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1a164351-8231-4150-a5c8-ed880417851c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ab8e24b0-c597-4081-9630-ec767933d218",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-28T02:39:02.1459969+00:00",
"db_currency_id": "5947a4ce-2d35-4e97-b0d8-1ecfbfc49cb3",
"db_currency_code": "sample string 10"
},
"company_type_id": "e48d7b53-92a8-4a12-8efc-5e04ad9f78c8",
"company_type_name": "sample string 32",
"company_type": {
"id": "de8e5b80-1e54-4412-aa99-7c4852f0f755",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "391de35a-13ca-44d4-ada4-c93e1804571b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2ab4f37c-6402-41ac-8f4b-285c5fff4404",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c015f686-1f84-4450-a191-57aa95e47dfa",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a5ab314c-2093-452e-8f34-ac0ac561f298",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5bbec60c-d93b-469d-a358-1dcf8ed78d9a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-28T02:39:02.1459969+00:00"
},
"company_sector_id": "edbca2b6-f7fc-4cc6-a486-5b1592290705",
"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": "184c960d-f085-4dfa-9bd8-0e245910203a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8fa0762b-90c4-477f-ba07-5bf0eb3acf7d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c5c2454e-c14e-453b-92c5-58c7883c4ec7",
"account_manager_user_code": "sample string 56",
"company_status_id": "d9685c01-4a20-408f-88b2-6c9cd319502b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-28T02:39:02.1459969+00:00",
"id2": 60
},
"db_language_id": "9fd6a3ea-bf4c-451c-9873-0f7d3d2bcb99",
"db_language_code": "sample string 7",
"db_title_id": "9915deb5-e220-4324-9506-de03ee6aa4b4",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-28T02:39:02.1459969+00:00",
"create_date": "2025-12-28T02:39:02.1459969+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-28T02:39:02.1459969+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.