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": "c2449857-47bb-466f-a158-6e508407e95b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f1006535-df56-400d-b1e3-beb30d37141e",
"company_code": "sample string 5",
"company": {
"id": "591619b1-f62d-4577-8cea-d493467d198d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-20T10:03:11.4743058+00:00",
"sales_territory_id": "a26363d4-c1f2-41b2-b7d0-b02a90c02cec",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "151596d4-d5b0-4fd8-9764-bb1f2c7e0897",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "61dba3d4-10b1-4566-8e42-27787d7a8ed9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3d156e90-be60-450a-a26b-258516304cc2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b029768f-db6d-40b7-8cf4-8564bbe6d730",
"db_currency_id": "2e0186e5-802b-4f1b-81e3-11f12d701184",
"db_language_id": "f390bd72-2733-40fa-b049-7fdda88a51b1",
"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-20T10:03:11.4898128+00:00"
},
"modified_dateutc": "2025-12-20T10:03:11.4898128+00:00"
},
"marketing_segment_id": "8140f9a0-f33a-4257-b6e8-b3b3e9ccbbf6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3e38d159-082b-47c7-b30a-f7cb69aa5b8c",
"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": "588c9880-8a47-4c49-9f1d-1ec1a7fb6358",
"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": "c46972da-426a-41f1-841c-da2f5227cca5",
"db_country_code": "sample string 28",
"feelist_id": "396f2248-eae1-4a79-aa8a-d47c9ff96c5e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "fcef772c-4947-4d6f-a0bd-8bf7227a7e4c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "43603640-8dc9-433a-bcc9-6d1d69d3e681",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-20T10:03:11.4898128+00:00",
"db_currency_id": "c1d5c632-2a0d-45c0-9f89-2d36fb9fc3a7",
"db_currency_code": "sample string 10"
},
"company_type_id": "014e542d-9b23-4c3a-b61b-e71ccffd2ac1",
"company_type_name": "sample string 32",
"company_type": {
"id": "29ff58d9-2c4c-4dd5-87b6-ff2412894d35",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3c528326-8f71-4d67-8d8d-ff8b6adcf9c0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a2de60ae-d42b-48c1-ab5c-ba8b34f014ec",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d4b31db1-5c6c-4f74-9f47-b34701457a9c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "07399ae8-3f9e-40d8-afea-0c39d1eb5a3b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "df13133d-7db1-4fc7-a06c-ae8a26f86335",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-20T10:03:11.4898128+00:00"
},
"company_sector_id": "957c19e3-7d03-42b4-aba3-607a19eb5364",
"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": "8e77c0bc-f0a4-4ad3-b7a8-9c89cd6fbb4c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1ce6bfa6-50fe-4bff-aac0-5ff4969d581f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b4a5b29c-1571-4fdd-90f8-c438b6f293f3",
"account_manager_user_code": "sample string 56",
"company_status_id": "7830a3be-773c-49fa-ac33-50825f012e8e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-20T10:03:11.4898128+00:00",
"id2": 60
},
"db_language_id": "3ad8e0b6-81bb-48b3-bbf1-327d9a89272c",
"db_language_code": "sample string 7",
"db_title_id": "61db00b9-4485-465f-892f-cb7044e959c8",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-20T10:03:11.4898128+00:00",
"create_date": "2025-12-20T10:03:11.4898128+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-20T10:03:11.4898128+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.