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": "4b1ae852-587b-4583-9b66-f286b5c95fbc",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "88948106-8998-434a-a7cc-a8af562ac4cf",
"company_code": "sample string 5",
"company": {
"id": "b515da98-0218-4d52-a521-d54555213233",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-08T05:24:10.3675584+00:00",
"sales_territory_id": "28c38648-95a9-4e12-a812-aa78ca5abbb2",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "164fb71e-06cf-452b-825e-b8293a5cf2b3",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6b3f119f-a3dd-485e-bbb1-913e5f0660e3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b84d83b5-fd68-4d9f-8ed0-5792a7e9ed9f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6250349a-aa3d-43f0-ab13-60530a989ea4",
"db_currency_id": "8d962e67-6e1f-444c-91bf-06922d072b8e",
"db_language_id": "e833e613-22eb-4503-9f9e-b63d7aa14b4e",
"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-05-08T05:24:10.3675584+00:00"
},
"modified_dateutc": "2026-05-08T05:24:10.3675584+00:00"
},
"marketing_segment_id": "8099abc2-86e1-426f-9ae5-d8f29db60941",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7f118b35-8316-49f5-86cc-b9d0be623abb",
"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": "cc694dca-e135-4ab2-a68a-6320278ec300",
"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": "28b0eb5e-2c15-4fef-9595-b658da964d3a",
"db_country_code": "sample string 28",
"feelist_id": "9c4f28f2-8623-4548-b0da-461cb851856c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "92d3dafb-1f22-492a-bc58-7f005baa6241",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0bc283cb-8dcd-466c-b546-8f393a603049",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-08T05:24:10.3675584+00:00",
"db_currency_id": "9f091ba8-4a29-434b-8f65-612b55001a23",
"db_currency_code": "sample string 10"
},
"company_type_id": "47d94ec3-7eec-4947-abc1-d48c7ec10d41",
"company_type_name": "sample string 32",
"company_type": {
"id": "ad8063eb-530d-41b5-bf6f-c287b65c9080",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c5eeb7c8-bad7-4685-9462-44fe9c55634c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7434a5ac-901f-4661-b1e9-a47c5b8f2740",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "b700dc73-b387-42a9-a1a1-91a53ae397d4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "06f80517-f370-4e2e-8c2b-e55731308e61",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b07555a6-b85f-45b5-86fc-047be5d5ca4c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-08T05:24:10.3675584+00:00"
},
"company_sector_id": "31aea9bf-c063-4e0f-b77e-7f49250126aa",
"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": "06ef6229-4a35-4722-836b-6be451a0f29a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7ccc6c01-d658-468b-8e73-60e6d18e4929",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b04aa8c9-d8b1-43e5-b36d-fcf5f88243a4",
"account_manager_user_code": "sample string 56",
"company_status_id": "2a418eeb-ccb2-4373-8131-efe1a35376b8",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-08T05:24:10.3675584+00:00",
"id2": 60
},
"db_language_id": "29c1bb43-4e21-4daf-85a1-4bbbce51797c",
"db_language_code": "sample string 7",
"db_title_id": "a58b4ba6-2215-464c-8e0c-02224260bf40",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-08T05:24:10.3675584+00:00",
"create_date": "2026-05-08T05:24:10.3675584+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-05-08T05:24:10.3675584+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.