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": "67deb1dc-d658-4237-a46d-07ab87c956de",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "dc790284-a5d1-4913-ac0e-015030bb9637",
"company_code": "sample string 5",
"company": {
"id": "9beb621c-dd0b-4e31-ba8e-4af6555be793",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-17T11:43:16.2799826+00:00",
"sales_territory_id": "00c44d08-a316-4219-8331-3231fa9ad715",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f6da3357-38e6-457b-8cff-1aba64648dab",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "73597875-55ca-4bc4-b986-6cad3e746fee",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0d174433-2b16-4817-a0f4-ce802bd4ed57",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8f2347c5-0d9e-4998-a732-47f99a5510bf",
"db_currency_id": "19a52922-7e94-47bf-a6ee-ddedf2775a4f",
"db_language_id": "c5829db3-5248-4968-be3f-3aea8e24cb52",
"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-11-17T11:43:16.2799826+00:00"
},
"modified_dateutc": "2025-11-17T11:43:16.2799826+00:00"
},
"marketing_segment_id": "1db53fb0-be64-4e24-8751-1bffcd1184d6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "8d47e4d7-e250-4683-aa06-4010dc1a77bf",
"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": "c710653f-bc72-4dcb-9b15-37fa6108b65e",
"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": "cc88a9ce-bb67-4ed3-b1cf-e2a583c915c9",
"db_country_code": "sample string 28",
"feelist_id": "480ad9fd-d0ea-4db4-9da0-4e47e07cad9d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3baae8b3-1275-41cb-8a65-c42b99f1d665",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5e803aff-fecf-41a9-9741-11c6cb1b371d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-17T11:43:16.2799826+00:00",
"db_currency_id": "cf3d78ab-65d5-4cf7-8170-d24667807654",
"db_currency_code": "sample string 10"
},
"company_type_id": "bcf387db-a9c9-4425-9de6-e628288bf6fc",
"company_type_name": "sample string 32",
"company_type": {
"id": "aceb0ee9-82a6-414e-a0fa-1d5311f4be4d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ac8f866f-6bd5-4615-bc35-35e3feaa5313",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1c4463b4-127a-47b7-a4ba-502bc80d1098",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ce4ae635-6f0c-499e-88cc-c476c1ed512b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f3f23f85-00c6-4ae6-9a8f-2e777ea9b4ab",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "1d6ba268-61bd-44bc-9b46-50328ea0c2ed",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-17T11:43:16.2799826+00:00"
},
"company_sector_id": "d1f0fc39-0b41-481d-811f-cb1cb93293c6",
"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": "7ea9db73-3b9e-4750-9822-96d2b0796ac3",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "048b08d3-be71-4832-a621-0d7314c1a485",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "eeca971a-c33f-4548-9132-beca5a2273a5",
"account_manager_user_code": "sample string 56",
"company_status_id": "9b021b98-ba2b-460f-a18b-7b2bdc9f7de0",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-17T11:43:16.2799826+00:00",
"id2": 60
},
"db_language_id": "64291b9e-60cf-4565-b26a-ded42ee41bbe",
"db_language_code": "sample string 7",
"db_title_id": "0eb9ec08-4226-4044-8022-13e8f509c0af",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-17T11:43:16.2799826+00:00",
"create_date": "2025-11-17T11:43:16.2799826+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-11-17T11:43:16.2799826+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.