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": "db39129e-d79e-46de-bc31-f119c32183ef",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "70fe4bfe-af2c-4a20-8259-d96cecbb931c",
"company_code": "sample string 5",
"company": {
"id": "af13bce1-0918-4acd-9bc4-9b1903248863",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-20T21:26:56.0761611+00:00",
"sales_territory_id": "c8c52379-a134-4ea1-b0a6-b082314e73d1",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "12025b9d-88f8-4be5-a455-010839301acd",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2577e7f1-0d00-41e9-b46c-7c5b985670c9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "863b9d69-f238-47f5-aa35-855235b9b378",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "53acc52c-ee18-40ce-808f-58dd9e7209ac",
"db_currency_id": "ee1a571a-786b-4068-957d-fdfc4ee07f1a",
"db_language_id": "e58bf014-56ae-4bc5-86f6-c7a090180e43",
"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-09-20T21:26:56.0761611+00:00"
},
"modified_dateutc": "2026-09-20T21:26:56.0761611+00:00"
},
"marketing_segment_id": "b1468ac8-2674-479d-be56-5f6d29662a81",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "81abb6b0-ee02-4691-a19e-17c18471b7cf",
"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": "6e84acb8-ec0c-4f35-a040-d64c32886d33",
"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": "ca690a58-3005-4149-aa46-a61b70feaa08",
"db_country_code": "sample string 28",
"feelist_id": "f4f08ec7-4fa3-400d-b03b-811008ad1edc",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "307e0348-8c86-4bc6-b1ff-c89196bc3b07",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1ba0d908-7035-4daa-a8d5-451ca8f7f485",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-20T21:26:56.0761611+00:00",
"db_currency_id": "a04d340e-9c00-47f2-ae83-e928c47ffebc",
"db_currency_code": "sample string 10"
},
"company_type_id": "62af909a-ef03-4db0-9dfe-e9badf304856",
"company_type_name": "sample string 32",
"company_type": {
"id": "a41da196-de06-4585-89bd-2bba6e857532",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a6e69b8c-ac6b-437f-a7c5-7391e94c7a0d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "943acdd5-a501-4ee4-971c-66b094086e90",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4e4024ca-f1eb-4cd7-bb24-bdd1ed478857",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "13ea9803-dcd6-4997-be23-53ff4e3ec81d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ca9f9a7c-15b6-412f-9cdf-82ca6ff697b4",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-20T21:26:56.0761611+00:00"
},
"company_sector_id": "6011a6c6-db26-46c9-bb09-c33168e453bb",
"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": "fff1cc66-6223-43a3-9d8f-4147e85214b2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4dc31d25-6008-4c9d-ba90-4bbb4f4ee171",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "1fb2ebfd-a836-4fad-8a99-4db776703a5e",
"account_manager_user_code": "sample string 56",
"company_status_id": "66dc6879-e8cc-4d35-bead-988ea6d188a2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-20T21:26:56.0761611+00:00",
"id2": 60
},
"db_language_id": "01c44898-781e-4cbc-aefa-ceb6e9bdcc4b",
"db_language_code": "sample string 7",
"db_title_id": "152e3b4c-a070-44b1-b73e-d838ad37bf89",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-20T21:26:56.0761611+00:00",
"create_date": "2026-09-20T21:26:56.0761611+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-09-20T21:26:56.0761611+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.