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": "cfbdb31c-150e-47fe-8d5e-87272753146a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d59bde9b-4145-45f7-80b1-9249efab82a6",
"company_code": "sample string 5",
"company": {
"id": "0ffc87dd-4df3-4aa1-aa7a-f0d034fae61a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-06-21T11:18:58.3562826+00:00",
"sales_territory_id": "6fbc8328-4827-42f2-9125-c728097543b9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d24728e6-ef6a-49d8-83c2-f04bd063b0fd",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "afe9648c-ccaa-47c1-a476-d612336ccee3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "25348f56-5b56-4965-aa55-320412c18bdd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ec8dd32a-803d-4e02-a946-3524575ea5f7",
"db_currency_id": "d0777c71-e9cd-412c-acb8-f9e1c8700939",
"db_language_id": "4b33e8fb-b7b3-4923-9ff1-ea450ec5a637",
"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-06-21T11:18:58.3562826+00:00"
},
"modified_dateutc": "2025-06-21T11:18:58.3562826+00:00"
},
"marketing_segment_id": "f939be35-8a52-4ec3-bb50-b9deb2896038",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "51994ea1-9955-4262-bb36-0402e43396c2",
"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": "d631bf2e-3302-4476-812e-443833823774",
"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": "1a1a64fe-0efe-433c-9357-90a6a59919e4",
"db_country_code": "sample string 28",
"feelist_id": "b03127d3-f44a-4db9-8bc9-308d2e34cb5d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ade63d95-fb57-4c06-8ceb-61005cc8b27d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5bdc8a87-c769-4aea-b9fb-a4990f63e202",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-06-21T11:18:58.3562826+00:00",
"db_currency_id": "5dda732d-49bf-4b66-8d23-52a92ad3498f",
"db_currency_code": "sample string 10"
},
"company_type_id": "662a8e6f-aea1-4cfd-9ab1-3e91b43de9ef",
"company_type_name": "sample string 32",
"company_type": {
"id": "6279a924-885a-4aae-80cd-44d8cb17c297",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e2f17839-6784-42a6-b4b8-897cd18ed0f0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "263e19fe-235f-448c-a669-2153edb65a59",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3833e4ce-26bc-47c3-a36c-6342151a81e8",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "97c0dda6-9dd0-4cfb-8d2c-3b42d4dcf319",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7556b9b3-1fc3-4d10-9a11-2381824f0bc4",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-06-21T11:18:58.3562826+00:00"
},
"company_sector_id": "5e69eb34-0f38-4e40-8dd7-0322ba40122a",
"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": "8fee3550-22eb-4d0a-ad3d-1759b317b513",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "363c4567-e9f4-4a19-a255-120323967097",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "99a5c853-285d-4d02-8a87-75f66b9f3140",
"account_manager_user_code": "sample string 56",
"company_status_id": "8dd0ca08-4911-45d3-81da-f1cf536cb7c5",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-06-21T11:18:58.3562826+00:00",
"id2": 60
},
"db_language_id": "1e0569e8-ce00-4110-a158-97220d28fe71",
"db_language_code": "sample string 7",
"db_title_id": "a5232296-2fec-44bf-80a0-af326e287351",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-06-21T11:18:58.3562826+00:00",
"create_date": "2025-06-21T11:18:58.3562826+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-06-21T11:18:58.3562826+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.