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": "f69ab6e6-79af-4cbb-a629-b060aaa9b66c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "331f74af-da5f-4ee5-9f7d-3b791788b409",
"company_code": "sample string 5",
"company": {
"id": "d1c3bbda-d425-4fdc-91bd-2135e974ad7d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-04-02T10:58:20.6295045+00:00",
"sales_territory_id": "f186339f-1638-4fba-a388-46d11fa22792",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "cd9fae4e-dca1-43cd-a1b6-5f388b388fdd",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ab83d030-d788-491a-a71d-d067eabd197a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "14fef540-6e2a-400d-9232-1c292e23b468",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a6cdfb9a-6902-4ee2-8345-a2aa580d609a",
"db_currency_id": "f2485ff7-435f-4b7c-ab39-0d7e4d7f60dc",
"db_language_id": "f4d6ab06-e20b-4b42-a8db-c619cb7376f4",
"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-04-02T10:58:20.6295045+00:00"
},
"modified_dateutc": "2025-04-02T10:58:20.6295045+00:00"
},
"marketing_segment_id": "d3f9f45d-22d9-49cf-b311-646f4eeda3df",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "013ba304-1575-4aba-a014-c214606fa13c",
"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": "f0a6678a-0846-4002-9bf0-9823259c08c3",
"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": "9fc61f08-a529-4282-ab93-293f3121d326",
"db_country_code": "sample string 28",
"feelist_id": "76544a1f-f86e-4071-bff3-85ca8c3be507",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "55b07fc5-7a65-48a2-a1eb-90fb60edc786",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b5a18679-b166-4f19-85df-0f96bf407d97",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-04-02T10:58:20.6295045+00:00",
"db_currency_id": "e3f7327d-9ff4-406a-876f-83825ce36082",
"db_currency_code": "sample string 10"
},
"company_type_id": "056e790a-2d2b-48ae-b427-71ae15c76727",
"company_type_name": "sample string 32",
"company_type": {
"id": "11cf1e15-b070-4bf6-96df-9497b91d7463",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2fbb4036-10ff-4761-b2fe-c7c9212be524",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a455f96d-660f-42bf-afdc-e8254942a8e7",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "89760e6b-aefb-41dc-b0ac-e41ea8cf6c80",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7225c004-6176-44c3-8b1b-ba05927c5d5d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a9fe9dd7-0b48-49e5-aea3-cd71b2a8d4c9",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-04-02T10:58:20.6295045+00:00"
},
"company_sector_id": "f02971f9-d18e-4c2d-a073-5060ed5f0bf7",
"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": "31739db8-8261-46d9-ad19-228728afef18",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "19b7dcf1-4bf6-42b6-bc39-42d444bfbb49",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "95ec7045-3b1a-49d7-9a79-7576fe86d94b",
"account_manager_user_code": "sample string 56",
"company_status_id": "5d7ac936-0e36-4d8f-a8d5-14883d0c9b53",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-04-02T10:58:20.6295045+00:00",
"id2": 60
},
"db_language_id": "0c2df42f-1d47-4fab-a570-58a161262473",
"db_language_code": "sample string 7",
"db_title_id": "5d9a7ca6-1746-4ee2-a14d-4163b70f2170",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-04-02T10:58:20.6295045+00:00",
"create_date": "2025-04-02T10:58:20.6295045+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-04-02T10:58:20.6295045+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.