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": "8535436b-f78b-487a-89ec-bd245f9a6763",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "43d4fc41-5c2b-4b08-bf1a-ace4cf83343b",
"company_code": "sample string 5",
"company": {
"id": "4cf78e84-710f-4980-ab33-b3f0199e4299",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-14T06:26:05.0239123+00:00",
"sales_territory_id": "d504410d-026c-4917-b92f-ce4c24c67398",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0331f42a-cabf-418e-a1cc-fd9925fb71ac",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9ff43fe2-430f-4f4d-93eb-29082a715978",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "90db6776-51fa-4efc-9f11-cf57cdd447c5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b831e902-c8f1-4a5d-97aa-5e937248d024",
"db_currency_id": "5717ea88-185e-470d-b2d4-94ce7ea199f4",
"db_language_id": "b2cc95cd-7a76-4c66-ba63-4049fb8f787d",
"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-08-14T06:26:05.0239123+00:00"
},
"modified_dateutc": "2026-08-14T06:26:05.0239123+00:00"
},
"marketing_segment_id": "48f15417-b0a4-4888-8b34-490313a469a2",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e62d4689-4d88-44a7-8f4b-50dde5fb94c2",
"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": "10172fe7-b4e1-4dcb-96d4-c6c0282513a4",
"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": "97bf062f-432e-49e6-8b34-8a12fd782fe6",
"db_country_code": "sample string 28",
"feelist_id": "5c04c94e-1e82-4268-91ae-850a8f8d1bdc",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "01a8308e-2288-40f0-8230-e0a1354c1db3",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2f8ae0f6-b98b-404a-955a-8ee5282c3d86",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-14T06:26:05.0239123+00:00",
"db_currency_id": "ca2f5de5-9eaa-4904-bb00-398e0ce037ad",
"db_currency_code": "sample string 10"
},
"company_type_id": "a5f6e885-7775-4e81-b1bf-23156ca311e6",
"company_type_name": "sample string 32",
"company_type": {
"id": "d50fe37a-76b3-4baf-a813-ffdcc8012e10",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b8ea66fc-58f1-4d59-85ec-222db2436ad6",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0f413c83-478a-4172-986a-e0fa4f32cc35",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f5011a04-82eb-46d7-b5c2-5ae9fc6c2697",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "9964aa64-a8d6-41e6-907c-697aba4e1806",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "74f5e0ba-3a99-4310-a841-41db542a263f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-14T06:26:05.0239123+00:00"
},
"company_sector_id": "95f5c50d-00fb-43c9-ba7a-b1114ded0e84",
"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": "ece6659a-3b04-4d07-ae1d-fe0c05db7455",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b6aadf17-975b-430c-b993-1ef514d20abf",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f5ee8f81-7911-459d-b95b-d9bdca24afb5",
"account_manager_user_code": "sample string 56",
"company_status_id": "b3dfecef-215b-4249-b092-f0d1153b934e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-14T06:26:05.0239123+00:00",
"id2": 60
},
"db_language_id": "8e2a9a3e-9ece-44fc-8422-1be8c111e66c",
"db_language_code": "sample string 7",
"db_title_id": "c8711a5a-491c-4778-9180-5659511d8010",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-14T06:26:05.0239123+00:00",
"create_date": "2026-08-14T06:26:05.0239123+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-08-14T06:26:05.0239123+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.