Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

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

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

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

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

Contacts / Update

  • Article
  • 3 minutes to read

Operation Information

Updates an existing contact within a ClickSend list.

This is a Premium Integration.

Authentication

This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type HTTP Basic Authentication (Username + Password).

To create a key of this type:

  • In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
  • Click on the + Create New Key button;
  • On the resulting Create New Key form, choose HTTP Basic Authentication (Username + Password) in the Type pick list;
  • Give the HTTP Basic Authentication (Username + Password) KeySafe key a Title (this is the name / identifier for the HTTP Basic Authentication (Username + Password) account as you will see it when using the cloud automation node in your workflows);
  • Optionally populate the Description field;
  • Populate the following fields accordingly, then click the Create Key button to create your new key:
Name Type Description
Username string Authentication Username
Password string Authentication Password
API Endpoint string Optional API Endpoint

Tip

The API Endpoint field is not required to be populated for this integration - just the Username and Password for an account which you wish to make the requests as.

Revoking Access

If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just delete the relevant KeySafe key(s) from the KeySafe list.

Warning

This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked HTTP Basic Authentication (Username + Password) account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
List ID listId number The ID of the list that the contact resides in Yes None provided
Contact ID contactId number The ID of the Contact Yes None provided
First Name first_name string First Name No None provided
Last Name last_name string Last Name No None provided
Phone Number phone_number string Should be in the format +447777888999 No None provided
Fax Number fax_number string Fax Number No None provided
Email Address email string Email Address No None provided
Organization Name organization_name string Organization Name No None provided
Address Line 1 address_line_1 string Address Line 1 No None provided
Address Line 2 address_line_2 string Address Line 2 No None provided
City address_city string City No None provided
State address_state string State No None provided
Post Code address_postal_code string Postal Code No None provided
Country address_country string Country No None provided
Custom 1 custom_1 string Custom 1 No None provided
Custom 2 custom_2 string Custom 2 No None provided
Custom 3 custom_3 string Custom 3 No None provided
Custom 4 custom_4 string Custom 4 No None provided

Output Parameters

Display Name ID Type Description
Status status string API Call Status
Response Code response_code string API Call Response Code from ClickSend
Response Message response_message string API Call Response Message
Contact ID contact_id number The ID of the newly created contact
List Name list_name string The name of the list that the contact was created within
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document