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": "c961b1a9-ee17-42c2-b3d1-ddc5746ae156",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e80f8979-e22f-4bc0-ab3d-0d966f8aad12",
"company_code": "sample string 5",
"company": {
"id": "7a54d515-48b8-430c-9a3c-899c8e749394",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-06T15:30:45.0658174+00:00",
"sales_territory_id": "1042ce3a-2d06-4c7f-a7c3-236a0db0628f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5773778e-75b9-4bbc-9599-65745d47af60",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "60656574-11f3-4380-82be-77b749db39bf",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e936426e-bd39-4ecd-ab3b-76bcdce19dba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f3b658d6-7873-40c7-9425-5206271c782b",
"db_currency_id": "e1a8e79a-7223-4d51-b18e-58ccd22eaad5",
"db_language_id": "dc3de522-33c8-4464-9876-a610d76818cd",
"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-06T15:30:45.0658174+00:00"
},
"modified_dateutc": "2026-09-06T15:30:45.0658174+00:00"
},
"marketing_segment_id": "6ec44448-de49-4ee4-8955-41e6ae627e5c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "dc22341c-2e89-480b-aa8d-057f8dba80a4",
"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": "b741b0fb-84d2-415d-87c7-c3d846a799dc",
"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": "8cff57be-072c-4899-9935-0b11a125d9f3",
"db_country_code": "sample string 28",
"feelist_id": "9d76e087-6137-4aff-aeae-b971bd19433a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "20fb507e-3be0-4906-bf0b-c6e8f3f46234",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "3a6c5131-56d1-4d2b-b412-3689f916a547",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-06T15:30:45.0658174+00:00",
"db_currency_id": "2be912d4-b55d-4260-8779-ac7b9c9a17bc",
"db_currency_code": "sample string 10"
},
"company_type_id": "1e163faf-d5c5-4b5b-8d54-9198f6afa615",
"company_type_name": "sample string 32",
"company_type": {
"id": "1fe556e9-82d6-476f-b4fd-c22e6e6ce4b2",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "63f089b0-ad7d-40e7-a993-70c2be81763b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d6895972-284e-477b-91fc-f05a48fefb64",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "97f063de-4d98-4c46-b036-e27022a3e8a9",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "33d7c6ef-2ecd-40a5-8959-81fb163a5fba",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f9ff7604-41cf-42c7-a057-2edde57874dd",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-06T15:30:45.0658174+00:00"
},
"company_sector_id": "b8c65af9-bd03-486e-bfbe-cb3528443144",
"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": "2d1c3237-9f03-47fe-ab77-c9a6d314ff84",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "39d23065-b002-45d0-9db0-d9a98f10ffe4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "abb38c49-2786-46da-8f40-2aa950a846fb",
"account_manager_user_code": "sample string 56",
"company_status_id": "dc71946f-f9ce-47a8-8c96-de533b53a88e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-06T15:30:45.0658174+00:00",
"id2": 60
},
"db_language_id": "ed02abf4-6264-408e-83d5-947146f8028f",
"db_language_code": "sample string 7",
"db_title_id": "1c4edf5e-947c-4af2-81d0-b2d88964c7f9",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-06T15:30:45.0658174+00:00",
"create_date": "2026-09-06T15:30:45.0658174+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-06T15:30:45.0658174+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.