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": "9847bbb8-83a1-46a0-aa21-a5d4612a016a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d11525fb-6fd8-44fd-9c31-febfa08dfc42",
"company_code": "sample string 5",
"company": {
"id": "525cf26b-5bca-4a21-9ba5-0afb134baf00",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-23T02:20:26.2991989+00:00",
"sales_territory_id": "f327f471-629b-4ac3-9a5b-89302a235c36",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ce594bf9-ea59-4854-9f81-d3375cffc344",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "69a69f04-cc89-4a24-90f2-d50338cb48a3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b779179a-2a66-4613-bf73-f5d26a96706d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5622598-d28e-4bfd-816c-5dcc737ffd25",
"db_currency_id": "ba44d439-3fdc-449c-80d3-1b3500a09f93",
"db_language_id": "b616b392-0db6-470b-88fe-06492d58ed71",
"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-07-23T02:20:26.2991989+00:00"
},
"modified_dateutc": "2026-07-23T02:20:26.2991989+00:00"
},
"marketing_segment_id": "12c9b7a3-e14e-4298-ae45-8977e6796344",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "149e7817-1676-46e8-bf8a-393747fb635e",
"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": "4d14fd80-4410-47bd-b75c-69eb46ba4322",
"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": "65a166f8-b943-48fa-9732-5c95b49006fc",
"db_country_code": "sample string 28",
"feelist_id": "bc7f6257-c684-491b-9924-1954b5ec91ee",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ee0918c4-a750-4d21-8886-2b10e4b82264",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6dc563e6-3c7b-48d1-ba25-3c1f84606575",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-23T02:20:26.2991989+00:00",
"db_currency_id": "b86cf746-a05f-4dac-ae7f-623ba85b8116",
"db_currency_code": "sample string 10"
},
"company_type_id": "ee79236a-50ba-417c-88c4-e0993953526e",
"company_type_name": "sample string 32",
"company_type": {
"id": "2674800c-8b51-45c5-a35a-ee985ef7fc74",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "75ed08a5-c605-4931-b151-f305584969f6",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e213cca7-2815-42f2-b290-dd1bc9acff16",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "2131998a-ea03-482b-9273-a57dda0f3e09",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "785a6fa5-48a4-4930-b81c-c1e2f8853187",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7259d940-c878-466e-a6e7-66b51a8e2ed5",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-23T02:20:26.2991989+00:00"
},
"company_sector_id": "5103927a-6fce-4997-83da-70eadf979211",
"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": "82110621-42d5-4c9f-a360-6e661d9aff1f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2d166af9-80c4-460b-b042-247e5a94e8d4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ce3a17dc-8cef-48bf-8d8a-22d1ece241f5",
"account_manager_user_code": "sample string 56",
"company_status_id": "b5132392-1cbd-436c-9c6d-be051b8ef97b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-23T02:20:26.2991989+00:00",
"id2": 60
},
"db_language_id": "b48c1cd2-4ef3-43dc-bbc0-f67cb67ef292",
"db_language_code": "sample string 7",
"db_title_id": "0d9c43a1-b062-4284-b6b8-9865726fa804",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-23T02:20:26.2991989+00:00",
"create_date": "2026-07-23T02:20:26.2991989+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-07-23T02:20:26.2991989+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.