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": "2afda589-547e-4822-82cf-b3dde8a3aaff",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f33f0aa8-b0b6-4a17-b97b-47dc141bc8c2",
"company_code": "sample string 5",
"company": {
"id": "d2df150d-c133-469d-9fb4-e4cd99a751a4",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-09T05:14:33.2500352+00:00",
"sales_territory_id": "584ff6b1-bc14-410c-a466-8d1991f14499",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a9cfdd0b-4210-4752-a7cb-0d9846a39612",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cc108828-8161-4ad0-9668-6d2213ec953b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8d71e8fa-8d0a-4a56-b2ea-d803a781befd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9e5ca049-7a3d-4d0e-8357-2410fbad0bee",
"db_currency_id": "421eedbe-e268-4140-aaba-d51be224f5f5",
"db_language_id": "e6325663-6a31-4c7d-bc54-1726f2756701",
"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-08-09T05:14:33.2500352+00:00"
},
"modified_dateutc": "2026-08-09T05:14:33.2500352+00:00"
},
"marketing_segment_id": "3cca5309-f3ef-420c-b22c-2a0cb1e2b36e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f5858b45-8d7c-4c5d-9d39-e842a0f23e48",
"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": "304c74b1-94f5-498d-88bc-3e37f9a2c971",
"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": "5a766eb5-5779-4dad-b7a6-c315d6f2bc85",
"db_country_code": "sample string 28",
"feelist_id": "1c5c1d94-506d-4c27-92f3-ae6e7d456406",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d12358f0-a5ef-4d7f-a1f1-456e6486a96d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5643e1b9-28c4-41d1-9a54-618c48682c5b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-09T05:14:33.2500352+00:00",
"db_currency_id": "96ad7618-c875-49d3-9f0e-be20e84b20ed",
"db_currency_code": "sample string 10"
},
"company_type_id": "95716e31-75cb-42e1-bf90-d133bae15bb4",
"company_type_name": "sample string 32",
"company_type": {
"id": "a0201209-867b-47f1-9fd3-12a2244686ee",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4075808c-5ab3-45f2-848e-4771c58beb9a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e8c2d46f-1a48-401d-bf0a-60be3f4584c5",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a1c4555e-3ecf-4a38-aaf5-03dd9f43e9e8",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "48fa3232-d59a-46f3-8f30-f3816fcf7e31",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2a84c0f5-680f-4782-bc94-7b67ac10d695",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-09T05:14:33.2500352+00:00"
},
"company_sector_id": "8d35184b-e149-4057-a0f9-df94016612d5",
"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": "b99d4f5d-9986-4fe9-aa17-25968088bac4",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "53088513-3dbc-43ec-a4d0-efea3b52eb51",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "10b47dd2-1ca1-459a-8545-615091b771cf",
"account_manager_user_code": "sample string 56",
"company_status_id": "ad2d372c-dd4a-4c2b-a884-1edf72e55c19",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-09T05:14:33.2500352+00:00",
"id2": 60
},
"db_language_id": "54fc3ca7-5be6-45a4-8ee6-cbe76ffe66a8",
"db_language_code": "sample string 7",
"db_title_id": "df284d27-8522-4103-8663-3f2eb67d247d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-09T05:14:33.2500352+00:00",
"create_date": "2026-08-09T05:14:33.2500352+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-08-09T05:14:33.2500352+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.