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": "389c0847-214e-485b-a0d6-2f1ac105e319",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "758976b8-3163-4dfb-962b-a5b7cb0c8d93",
"company_code": "sample string 5",
"company": {
"id": "07a96af3-ddd4-46c1-8e63-aecbcee0682f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-04T14:31:48.5806326+00:00",
"sales_territory_id": "ed61fa47-8689-4c06-bd25-3c4260acea8a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a8a2e059-5de5-4a07-b8a0-7c97db008cbd",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "47383b37-be59-4f2f-8379-f770ce9b692a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1dad6c88-ff14-4a91-87d4-1a9e7b39df1a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "881a48d2-ebf3-42b9-accc-233f19f6d7fb",
"db_currency_id": "4c66399a-fb0f-45a2-bcc7-16616ab2784c",
"db_language_id": "b86797bf-1629-4e2b-a56a-8b7e6d5c6077",
"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-09-04T14:31:48.5806326+00:00"
},
"modified_dateutc": "2025-09-04T14:31:48.5806326+00:00"
},
"marketing_segment_id": "166fa885-8e03-46af-9d91-40b11815205b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1a70fe83-582e-46ae-9deb-be226a2e0994",
"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": "640b547f-29fe-4ba3-a8a9-9e8141f305ec",
"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": "3aed73e4-15e4-4e74-b2a5-a19776052f6e",
"db_country_code": "sample string 28",
"feelist_id": "3da7a46b-d6ce-4aa2-ad2b-0532db85f779",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "46b42efa-a8f3-4741-8289-04eee14ed108",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ef0ffe15-afda-4123-962f-47d5e2b59ab1",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-04T14:31:48.5806326+00:00",
"db_currency_id": "ec45684f-a3e0-4fc2-8972-9b565a223ffd",
"db_currency_code": "sample string 10"
},
"company_type_id": "10a5f10a-e1aa-4c42-bcde-7a13b7412239",
"company_type_name": "sample string 32",
"company_type": {
"id": "86344aae-5c6f-4355-b7a1-a65163d122e3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "eec9e32a-25fd-4ab9-abda-f76dc2339769",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7d33bd3a-1721-449b-9858-cec0a6a42c5c",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3e44c84c-99a9-44e1-9ef5-82329799d961",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "dd90ead4-5d6e-4187-a9cf-d4510ca52e29",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0e32f0de-ccdf-4685-a326-9fa2ad6c7855",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-04T14:31:48.5806326+00:00"
},
"company_sector_id": "caaeaa87-08c2-4625-b868-25e16c2a3df9",
"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": "f8ad23c2-98b3-40fb-9c49-fde76212d42d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8f3cabdd-f3ec-4585-8c57-e8d92f20719d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "fca112f2-b230-4e76-abe9-f467c62cf27f",
"account_manager_user_code": "sample string 56",
"company_status_id": "0f6105c1-e7da-43be-8f7b-4fe215bffcc9",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-04T14:31:48.5806326+00:00",
"id2": 60
},
"db_language_id": "0a6ffd7d-1edb-4453-b720-420de65a1347",
"db_language_code": "sample string 7",
"db_title_id": "331ea669-b479-47cc-944c-048a07bdcc6c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-04T14:31:48.5806326+00:00",
"create_date": "2025-09-04T14:31:48.5806326+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-09-04T14:31:48.5806326+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.