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": "ec3e03ac-3261-4d2b-b0f6-53558b1d8f94",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "073dd0f2-eb18-4c95-9f0e-682ec2dd2a79",
"company_code": "sample string 5",
"company": {
"id": "ea4bd027-87d8-4a57-9724-c2f2967c08b6",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-17T23:33:59.8028881+00:00",
"sales_territory_id": "4d554769-ff12-4f25-a7e1-753802ae1258",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "697f177f-be9e-463a-82b8-18fe31e2c864",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bc0352c2-58d2-4ae3-a611-2dd458db0bfe",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4bc62afb-92dd-4d7d-961e-49d301dbdde7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b601186a-c274-4f00-965e-35f07ba2fb1b",
"db_currency_id": "9f5c35f8-50c8-48f8-8355-fa1ae008acc7",
"db_language_id": "3ac299da-bd07-4596-a97b-6f8c3a368b09",
"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-17T23:33:59.8028881+00:00"
},
"modified_dateutc": "2025-11-17T23:33:59.8028881+00:00"
},
"marketing_segment_id": "30090b95-ab0c-4bfb-9580-899cd5296ee8",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b8a85c3c-2f6b-43e4-9646-d6a9d0a856e0",
"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": "04e382f3-e5ef-4428-a4c3-c9a4b8e7b986",
"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": "7ef05edf-cb88-4357-be1b-6e54aae6c027",
"db_country_code": "sample string 28",
"feelist_id": "3cd11e74-eac4-46af-bb8c-bb55784c39d2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ddaa94ae-a48c-4670-9586-2bc2cf7de58a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d3e345ab-6d99-4b4b-ab55-d361786ecfb2",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-17T23:33:59.8028881+00:00",
"db_currency_id": "d415261d-74e8-4e2b-bde4-1350c964b3ca",
"db_currency_code": "sample string 10"
},
"company_type_id": "d063a183-f1a1-49e7-ab9b-80e792cedf79",
"company_type_name": "sample string 32",
"company_type": {
"id": "bc904c14-0cdb-4fc9-9f64-23cb0a3969db",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "dba98955-b9f3-40c8-87a9-27eb41186fac",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3486b280-bab0-4cf7-ad07-59188a098db8",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f1d2bacf-8340-4113-afb8-26471c505dc9",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "beda67f5-e122-4be4-80bc-5ffc77781b4b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "19e6fc92-d84e-4a09-9160-051a1640f780",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-17T23:33:59.8028881+00:00"
},
"company_sector_id": "66f8c2d4-3556-4a91-82d1-33f607515d1a",
"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": "ef2b6a28-5997-4dd6-84e7-8d732adf7eb0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d09b7341-c0a0-46ae-8144-b6267753dd49",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "6c4839b3-9902-4a70-920a-ebe3c5948f15",
"account_manager_user_code": "sample string 56",
"company_status_id": "3a56c462-2992-4987-9ef7-af0da2db0cab",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-17T23:33:59.8028881+00:00",
"id2": 60
},
"db_language_id": "fd254796-7bed-47be-b125-30952633503a",
"db_language_code": "sample string 7",
"db_title_id": "55f26fcb-020f-403b-bef5-b85441073b32",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-17T23:33:59.8028881+00:00",
"create_date": "2025-11-17T23:33:59.8028881+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-17T23:33:59.8028881+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.