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": "840133db-23aa-42e3-bbc3-a9997db8ebb2",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8e2cdd26-5203-4fc8-92ad-805ea917d6d4",
"company_code": "sample string 5",
"company": {
"id": "9d73a45a-ea69-4fe8-be06-5eb8daab8809",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-05T14:14:45.4076595+00:00",
"sales_territory_id": "f05c17a3-5b4a-4d85-8016-426f4e834879",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "49fb4b26-2320-4a58-ad89-75a9656d9450",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e0759811-2237-4674-a7cf-3df3e3054a99",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0719179f-ccfa-41f5-8418-33251e47f821",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3ede7617-fc72-43b0-86d6-0d58ea2bf161",
"db_currency_id": "ac3b099b-8713-484f-82f4-e604662f9158",
"db_language_id": "8b86ca82-8d06-420f-ae8f-2aabf6f5478f",
"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-02-05T14:14:45.4076595+00:00"
},
"modified_dateutc": "2026-02-05T14:14:45.4076595+00:00"
},
"marketing_segment_id": "76f0d966-6b49-48a9-929a-a56d67de1ea0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e1909f10-f623-4ec6-aafc-d0206624df8f",
"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": "750ca643-8a88-414c-9c62-9e4b5d3c99de",
"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": "1bf3475a-d5ea-4ad6-9c96-4ac977488264",
"db_country_code": "sample string 28",
"feelist_id": "85163937-3755-4835-922a-b41157eafc64",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "35c0ef08-4e9a-4653-bdb0-f73cc8536e01",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "4a1c9d68-700c-4f8c-90f8-0ea2995f624a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-05T14:14:45.4076595+00:00",
"db_currency_id": "3b0716ad-cbaa-4ea9-a549-b88db485413e",
"db_currency_code": "sample string 10"
},
"company_type_id": "789d0be1-7f66-4202-bb6d-21d7c82b4d92",
"company_type_name": "sample string 32",
"company_type": {
"id": "5b54a0af-2b6e-403c-9729-12843750bcc1",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2508f23f-1323-431e-b27f-4879777a121c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "147a1380-8784-497c-8520-8cda5cb3d6ce",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c109e1d0-b89b-49de-8107-8e9da087c564",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "19a84ded-3628-4300-8bed-f410ad46ff60",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "64f1c1c8-00c0-406b-aa14-9bff5d20ef8a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-05T14:14:45.4076595+00:00"
},
"company_sector_id": "15750044-8b49-47bc-86e3-e1cd60be4738",
"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": "d264926a-2a26-45c3-8d90-3f936bedfaf0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "55cd402b-5aae-40d4-b4e6-53ecdfdea5d2",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9eabb78c-0d62-428f-b493-6a77f062d08d",
"account_manager_user_code": "sample string 56",
"company_status_id": "710f4ffa-f3c3-4ad2-985d-b423f60ad7b4",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-05T14:14:45.4076595+00:00",
"id2": 60
},
"db_language_id": "ab1b1734-dcde-45ad-87e0-d4418e5aa60d",
"db_language_code": "sample string 7",
"db_title_id": "18c9627c-8657-429e-92cc-af29f3fa001c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-05T14:14:45.4076595+00:00",
"create_date": "2026-02-05T14:14:45.4076595+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-02-05T14:14:45.4076595+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.