Documentation

{{docApp.title}}

{{docApp.description}}

INDEX

Documentation Library

Search for information on Hornbill Documentation.

{{docApp.searchError}}

{{docApp.searchResultFilteredItems.length}} results for "{{docApp.currentResultsSearchText}}" in {{docApp.searchFilterBySpecificBookTitle}}

Have questions about this site?


What is this site?

  • This website is Hornbill's new product documentation website and is currently under development.
  • It is intended that all existing and future public-facing documentation we produce will be available to search, browse and share.
  • Hornbill's current documentation is available at Hornbill Wiki but over time this content will be migrated to this documentation site.
  • Please feel free to have a look around at any time.

Why has Hornbill created this site?

  • Hornbill's products have moved on considerably since we introduced it almost 10 years ago. At the time, the MediaWiki tool was sufficient, but we have outgrown it.
  • Our customers are more enterprise focused and more self-sufficient than ever before, so for 2023 and beyond we have established a new documentation platform and team to drive our documentation initiative forwards.
  • We are aiming to deprecate the use of Hornbill Wiki for most Hornbill related documentation.
  • We want to enable our growing partner network with product resources and information, documentation beyond our Wiki approach is required.
  • We could definitely do with some help, and may even pay for some! If you have domain knowledge and would like to help, please check out our Hornbill Docs Contributor Guide and contact the Hornbill docs team at docs@hornbill.com.

What will this site be good for?

  • Community contribution will be facilitated, encouraged, and most welcome.
  • High quality documentation, will be kept up to date as rapidly as our products evolve.
  • Real-time content search and discovery.
  • Articles organized into books, books into libraries, creating a more natural and logical structure to our documentation.
  • Legacy API documentation and various other documentation sources will all be consolidated into a single unified documentation system.
  • Documentation available in browser as well as printable/viewable as PDF on demand.
  • Personalized documentation experience, allowing dark/light mode, article subscriptions, social media sharing and other useful features.
  • Almost all publicly available documentation on docs.hornbill.com will be open-source and available to fork on GitHub, allowing customers to derive their own custom documentation around Hornbill products should they wish to.

What is the timeline for this site?

  • We have taken the decision to publish and make available early, there is very little content at this time.
  • As and when we have completed/usable documentation, it will be published here.
  • We have a host of additional features we wish to add over time, so please watch this space.
  • We expect most of our existing documentation should be reviewed/migrated to docs.hornbill.com over the coming months.
  • The documentation project will be ongoing, will continue to expand, evolve and improve day-by-day.

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

Contact Entity - update

Operation Information

  • Application Reference: com.hornbill.core
  • Scope: Entity - Contact
  • Class: Entity
  • Required Privilege Level: none
  • Required Rights: none

Description

For internal use only - Update Contact

Request Parameters

The update API takes the following input parameters. It is important to note that the parameters must satisfy the requirement of the input validation checks.

Name Type Required Description
id xs:integer Yes Primary Key
firstname xs:string No Contact First Name
lastname xs:string No Contact Last Name
email1 xs:string No Contact Email
email2 xs:string No Contact Second Email
email3 xs:string No Contact Third Email
tel1 xs:string No Contact Telephone
tel2 xs:string No Contact Second Telephone
tel3 xs:string No Contact Third Telephone
jobtitle xs:string No Contact Job Title
description xs:string No Contact Description
company xs:string No Contact Company
notes xs:string No Contact place to add long text
country xs:string No The ISO 3166 alpha 2 country code that the contact is located in. If not set, the country set for the portal account is assumed
region xs:string No Logical location of the contact
language xs:string No The RFC3066 language code defined for this contact
timezone xs:string No The timezone that the Contact is located in If not set, the timezone set the portal account is assumed
status xs:int No Contact Status: 0 = active, 1 = suspended, 2 = archived/deleted - XMLMC accountStatusType
owner xs:string No Contact Owner
type xs:int No Contact Type: 0 (or null) = Contact, 1 = visitor
private xs:int No If 1 then this contact should only be visible to the h_owner. If h_owner is not set then is visible to everyone regardless
activityStreamId xs:string No The field used to store the activity stream id for the organization
custom_1 xs:string No Contact Custom 1
custom_2 xs:string No Contact Custom 2
custom_3 xs:string No Contact Custom 3
custom_4 xs:string No Contact Custom 4
custom_5 xs:string No Contact Custom 5
custom_6 xs:string No Contact Custom 6

Response Parameters

No response parameters are returned.

Code Examples

In This Document