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": "d459382f-7dc7-4d1a-bdfd-23e316c2a74f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "fd149609-7b08-402f-976b-49f105c7c188",
"company_code": "sample string 5",
"company": {
"id": "7ae24615-8a26-4e41-96e5-5baa8b2c5b07",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-08T03:21:55.9616867+00:00",
"sales_territory_id": "98e55a1d-da96-4f4c-96cd-3b97ff7a5841",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "53231c1e-23ed-42a7-bb69-20001751430f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "950dec34-7c0a-400c-a7d0-0b8c5a3077bc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fdcf4e80-3a7b-4643-b625-996ac454abdc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2f4d6931-ab41-42ec-86de-836d80c0565f",
"db_currency_id": "a20ea466-22a6-4868-be35-529d5bd58e9a",
"db_language_id": "f42e71d1-2df6-48b8-a15f-35ff3beee47d",
"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-09-08T03:21:55.9616867+00:00"
},
"modified_dateutc": "2026-09-08T03:21:55.9616867+00:00"
},
"marketing_segment_id": "4ce52f88-ec13-4806-8b36-81d0a75599c6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6ce9e5aa-a18f-4fef-8593-fe14b0bb6e38",
"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": "26651c15-50c8-4eee-a58a-317e58655f26",
"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": "28a708d4-5f88-42c3-8de8-23867fc4fe62",
"db_country_code": "sample string 28",
"feelist_id": "2f5390e5-6db4-47b9-84fe-92f24d4868fd",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a19573a1-e3e8-4f09-8941-6be21ca0fb15",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "df4bb2d1-32e4-4ab2-9f24-1b37593c9a4d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-08T03:21:55.9616867+00:00",
"db_currency_id": "628c0c0e-6672-4454-8ead-76926a145589",
"db_currency_code": "sample string 10"
},
"company_type_id": "d9650dab-f626-4f2f-8300-5f972a138413",
"company_type_name": "sample string 32",
"company_type": {
"id": "9c9e955b-a88b-4b9c-841a-65ab249f356b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4f3797d7-f22b-462b-96f3-416c3f1d981b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "63f2502b-00ca-4700-8ae7-036d754fd77c",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4f25e4da-5827-4d93-8dab-6153f0a4af5b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6618ca70-5e2c-4559-9896-699e80405658",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2ba271f5-b52d-4625-ba99-4ac4bd6f2969",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-08T03:21:55.9616867+00:00"
},
"company_sector_id": "7c1c2088-4e96-4723-8e3a-6edbba7ddfc3",
"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": "9f0066fc-e29f-445d-bf01-e76a2dc936ef",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e3c9c197-f1de-4c32-9572-6b17f4390df3",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "41975bde-8c2e-49b2-95dd-446954292964",
"account_manager_user_code": "sample string 56",
"company_status_id": "fbba9e2d-f0f4-4d7c-9f3d-84def6f6748d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-08T03:21:55.9616867+00:00",
"id2": 60
},
"db_language_id": "83b6ae18-3bc8-488b-b82a-1606562614a7",
"db_language_code": "sample string 7",
"db_title_id": "dd0e0428-ce5c-413b-a134-87f3e90c402a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-08T03:21:55.9616867+00:00",
"create_date": "2026-09-08T03:21:55.9616867+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-09-08T03:21:55.9616867+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.