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": "7d0f9a54-71bb-44d3-bd80-2ce8ab64cfb8",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "036c1bb2-43cf-47ed-8bbc-6b3572f581b8",
"company_code": "sample string 5",
"company": {
"id": "ab021c77-58c0-4d49-ba90-9308e57de4ca",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-05T22:16:26.5563467+00:00",
"sales_territory_id": "97117676-dfed-4366-b835-9a246ef8708b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e0c55078-6479-427b-a6f9-ab211f9058d1",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cbcde33c-b2ce-4975-9eb5-20bfe2b1f8e4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d0a3d615-7bc3-4bfe-825d-a9982700f248",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d875902-2852-4d04-9178-4664fc759762",
"db_currency_id": "73afea27-6465-45ce-9b2b-de382398ffc6",
"db_language_id": "69c06ffb-6b97-4645-968b-bb98fdc6c3df",
"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-05T22:16:26.5563467+00:00"
},
"modified_dateutc": "2026-07-05T22:16:26.5563467+00:00"
},
"marketing_segment_id": "5b26acc4-d573-4c45-9ee5-985e501a251a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "bcc95199-27e3-457f-867a-89cc4c513e33",
"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": "daa06d67-6ba8-4fe1-9d22-cfa2a66490d1",
"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": "64150603-320b-4353-829d-50a215b1af49",
"db_country_code": "sample string 28",
"feelist_id": "35c7ef9f-238d-4c79-9263-97a9bd993553",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8d71d9ea-b83f-4062-968b-798abe23bf57",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6766f908-0cfb-4ed2-a596-2e6ba32a6e2b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-05T22:16:26.5563467+00:00",
"db_currency_id": "04c21c03-9a47-466b-98a3-36ef76c985a4",
"db_currency_code": "sample string 10"
},
"company_type_id": "643113a5-db9b-47d2-b217-6c8d7cc2079f",
"company_type_name": "sample string 32",
"company_type": {
"id": "3b4d1309-b40f-408b-8c37-59b4271d8d47",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8d32d295-939c-4d45-b61c-c494bb7c23e5",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1edd4a8b-8e70-41be-882e-c34d9fa7dbfc",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7e850ba4-bc22-423a-9042-537dedc8f21c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "02e0e036-f1d1-486b-a2b4-6d9f4ba8fc21",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "80ec15bd-685d-4502-a405-275d516963cf",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-05T22:16:26.5563467+00:00"
},
"company_sector_id": "8b4a48c0-ef83-4079-aa5c-33fe637d3a6d",
"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": "8bf18123-1513-45bc-8a4c-c10098b80001",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "3d880a63-8093-4441-96b5-a701acb31f04",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "94ba74a4-a82a-4fca-ac70-30b52a033f26",
"account_manager_user_code": "sample string 56",
"company_status_id": "84c9ddbc-5c5a-4950-8b04-fcf59f93ac0e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-05T22:16:26.5563467+00:00",
"id2": 60
},
"db_language_id": "c524102e-cb2e-4c29-a065-9e41635c449c",
"db_language_code": "sample string 7",
"db_title_id": "742aa4ec-a39e-4a7f-9aac-0f52b48a1bfa",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-05T22:16:26.5563467+00:00",
"create_date": "2026-07-05T22:16:26.5563467+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-05T22:16:26.5563467+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.