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": "a669bc01-2c01-4871-9fed-d2f0354213f4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "9c9924b7-de45-43eb-9963-1aa72214fed4",
"company_code": "sample string 5",
"company": {
"id": "c65e4376-f8ad-4213-b05a-eeee8ae7d9ce",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-11T06:49:36.0859026+00:00",
"sales_territory_id": "07d5ecd5-ec29-44de-92ac-6d8a003558fd",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "569ca8dc-3d63-44d3-ad20-ba00602f2e98",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "40c85c06-652c-45ca-9cc0-7d6667c30499",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2457e54b-b679-4b76-93b8-748696a04426",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "67c27643-4405-4f2e-b205-354dfa386b3c",
"db_currency_id": "e1c88c3f-3021-4faf-9064-9d77f79567df",
"db_language_id": "ef089743-6d80-4b85-93dd-43e6ca3ea0ce",
"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-11-11T06:49:36.0859026+00:00"
},
"modified_dateutc": "2025-11-11T06:49:36.0859026+00:00"
},
"marketing_segment_id": "85ac067b-15d3-4552-8a62-d95ec93139e4",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2812cd7e-8cfa-4c79-961e-43c91d2f00b8",
"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": "5638490d-ca3b-4e8d-a188-498a74267be1",
"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": "bc22a6ad-862f-4a0c-980c-e97a76a6c4e7",
"db_country_code": "sample string 28",
"feelist_id": "e9c1a571-4c2f-4ac1-8612-cf22ea447d5b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f21922a8-1b13-4f14-8267-cba0fa286cc4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "4667434d-6fca-4040-82ba-404f31684b08",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-11T06:49:36.0859026+00:00",
"db_currency_id": "1b6fc574-8c6f-406a-bee2-4ceb46c03276",
"db_currency_code": "sample string 10"
},
"company_type_id": "95ea5cba-99c0-4401-91c3-5b820b6a9c8f",
"company_type_name": "sample string 32",
"company_type": {
"id": "062b951d-a357-486e-8f63-07ea9e555926",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e97f1f09-c246-4dd8-b2f1-97a045f06174",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9b8daa98-000a-465c-b850-7f913c8179dd",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "55106d2a-d960-493b-9d14-2448f46185e0",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a0f46bb2-0c81-49bb-82a1-7a8f8d123c46",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7de165d1-db55-485b-a583-f2dd557b9a03",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-11T06:49:36.0859026+00:00"
},
"company_sector_id": "76ad46d0-6a0c-48e5-b456-d63af9062f9e",
"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": "37963041-2124-4ff1-85e8-919d18c80b46",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b920a532-6328-42f1-95b1-e46652038880",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "552eb140-53f5-4b71-b4c1-a5d472f5896c",
"account_manager_user_code": "sample string 56",
"company_status_id": "1ed671ff-47cf-46bd-b10c-4a40a058c01d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-11T06:49:36.0859026+00:00",
"id2": 60
},
"db_language_id": "45b108b7-ff19-4091-b85e-1f663336d9da",
"db_language_code": "sample string 7",
"db_title_id": "bdb0aff9-66fe-4ae0-bb9d-f44721389939",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-11T06:49:36.0859026+00:00",
"create_date": "2025-11-11T06:49:36.0859026+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-11-11T06:49:36.0859026+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.