BoldChat by LogMeIn - Help Center

BoldChat Provisioning API

The BoldChat Provisioning API provides a programmatic way to create, edit and delete operators.

Compatible Subscriptions

Access to BoldChat's API is included in the Enterprise subscription.

Important: API access is assigned to your account identifier (AID) that you can find in all HTML snippets under setAccountID.

Configuration

Learn about configuring the BoldChat Integration API under API Configuration.

Operator Provisioning Methods

createOperatorFromTemplate

Creates a new operator from a template.

Important: It is recommended to set up a distinct base template operator in the operator client. The TemplateOperatorID parameter corresponds to the ID (loginId) of the template operator, which you can access in the Desktop Client or via the getOperators method.

When a new operator is created, the following properties of the template operator are carried over:

  • Complete login record
  • Business hours
  • Email signatures

The following properties are not inherited:

  • Any property set by the input parameter, such as the user name or password
  • Single Sign-On name ID (set to null)
  • My Canned Messages
Parameter Type Required Description
TemplateOperatorID integer yes The identifier of the template operator.
UserName string yes

The user name of the new operator.

Note:

  • Cannot be changed later
  • Length limit: Must be between 3 and 254 characters
OperatorName string yes The real name of the new operator.
Password string yes The password of the new operator.
Email string yes The email address of the new operator.
Note: Must contain the @ character.
EmailName string no The friendly name of the new operator. Used as the sender's name when the operator sends an email.
ChatName string no The new operator's name displayed in chats.
Initials string no

The new operator's initials.

Length limit: Maximum 3 characters

InviteImageCaption string no A text caption that appears under the new operator's image in certain types of auto chat invitations. This is usually the operator's name.
InviteImageUrl string no The URL of an image file for the new operator.
ChatImageUrl string no The URL of an image file for the new operator's chat image (shown next to each chat message).

Returns:

Parameter Type Description
LoginID string id The unique identifier of the new operator.

deleteOperator

Deletes an operator.

Parameter Type Required Description
OperatorID string id yes The unique identifier of the operator to delete.

editOperator

Sets operator properties.

Parameter Type Required Description
Departments string no A collection of department objects. Passing in this parameter overrides any previous set departments and sets them to this list provided. Example:
Departments=[{"DepartmentID":"12345","Priority":"3","AssignmentPriority":"3"}, {"DepartmentID":"54321","Priority":"1","AssignmentPriority":"1"}]
OperatorID string id yes The unique identifier of the operator.
OperatorName string no The real name of the operator.
EmailName string no The friendly name of the Operator.

Displayed as the sender name of the emails the operator sends.

ChatName string no The operator name displayed in chats.
Email string no The email address of the operator.
Note: Must contain the @ character.
Initials string no The initials of the operator.
Note: Maximum length is 3 characters.
InviteImageCaption string no A text caption that appears under the operator's image in certain types of auto chat invitations. This is usually the operator's name.
InviteImageUrl string no The image location that is used as the operator's invite image.
ChatImageUrl string no The image location that is used as the operator's chat image, displayed next to each chat message.

operatorLoginControl

Modifies the login properties of operators.

Parameter Type Required Description
OperatorID string id yes The unique identifier of the operator.
Password string no The password of the operator.
Unblock boolean no Unblocks the operator login.
Note: The only valid value is true.
Disable boolean no Disables the operator and prevents them from logging in.
ForcePasswordChangeOnNextLogin boolean no Forces the operator to change their password upon next login.
SSOLoginRequired integer no Sets SSO login requirements.
Valid values:
  • 0: Use account level settings
  • 1: SSO login required
  • 2: SSO login not required
SSONameID string no The SSO name identifier.
Note: Must be unique.

Canned Folders CRUD Methods

Create, read, update and delete Canned Message folders for easier organization.

getSetupFolders

Lists all Canned Message folders.

Parameter Type Required Description
FolderType long no* Pass FolderType to return a filtered list of folders. See FolderType (ItemType) for a list of types.
ParentSetupFolderID long no

Possible values:

  • If a valid long ID is passed, returns the children of the specified parent.
  • If null is passed, returns items who's ParentSetupFolderID is also null.
  • If omitted, ancestors are not considered.
SetupFolderID long no* The Canned Message folder's ID to be returned.

* You must pass either a SetupFolderID and/or FolderType

Returns:

Parameter Type Description
SetupFolderID long The folder's ID.
Name string The folder's friendly name.
FolderType long The folder's type. See FolderType (ItemType) for a list of types.
ParentSetupFolderID long The parent folder's ID.
AccountID integer The ID of the account that the folder is associated with.
Created datetime UTC folder creation date in ISO-8601 format.
Updated datetime UTC folder update date in ISO-8601 format.
Deleted boolean Indicates whether the folder has been deleted.
DeletedBy string id The AccountID of the user, who deleted the folder (if applicable).

createSetupFolder

Creates a new Canned Message folder.

Parameter Type Required Description
Name string yes The friendly name of the Canned Message folder.
FolderType long yes The folder's type. See FolderType (ItemType) for a list of types.
ParentSetupFolderID long no Represents a valid parent folder. The FolderType of the parent must match the current item's FolderType.

Returns:

Parameter Type Description
SetupFolderID long The created folder's ID.

editSetupFolder

Modifies an existing Canned Message folder.

Parameter Type Required Description
SetupFolderID long yes The folder's ID to be updated.
Name string no The folder's new friendly name.
ParentSetupFolderID long no Represents a valid parent folder. The FolderType of the parent must match the current item's FolderType.

Returns:

Parameter Type Description
SetupFolderID long The updated folder's ID.

deleteSetupFolder

Deletes a Canned Message folder.

Parameter Type Required Description
SetupFolderID long yes The folder's ID to be deleted.

Returns:

Parameter Type Description
SetupFolderID long The deleted folder's ID.

Chat Canned Messages CRUD Methods

Create, read, update and delete Chat Canned Messages to import large amounts of data, such as an entire knowledge base or FAQ to be used with the Auto Answers feature.

getChatCannedMessages

Lists all messages in the specific Chat Canned Message folder.

Maximum page size: 500 records

Parameter Type Required Description
FolderID long no

The Chat Canned Message folder to be listed.

  • If not provided, defaults to the root Chat Canned Message folder.

Returns:

Parameter Type Description
SetupItemID long The message's ID.
Name string The message's reference name.
Text string The message's content in HTML markup or plain text.
Keywords string The message's comma-separated keywords.
Subject string The message's friendly name, visible to visitors.
Language string id

The message's language.

  • If not provided, defaults to en.
  • Possible values: de, en, es, fr, it, ja, ko, nl, pt
FolderID long

The Chat Canned Message folder in which to store the new message.

  • If not provided, defaults to the root Chat Canned Message folder.

createChatCannedMessage

Creates a new Chat Canned Message in the provided folder.

Parameter Type Required Description
Name string id yes The message's reference name.
Keywords string id no The message's comma-separated keywords.
Text string yes The message's content in HTML markup or plain text.
Subject string no The message's friendly name, visible to visitors.
Language string id no

The message's language.

  • If not provided, defaults to en.
  • Possible values: de, en, es, fr, it, ja, ko, nl, pt
FolderID string id no

The Chat Canned Message folder in which to store the new message.

  • If not provided, defaults to the root Chat Canned Message folder.

Returns:

Parameter Type Description
SetupItemID long The new message's ID.

editChatCannedMessage

Modifies an existing Chat Canned Message.

Parameter Type Required Description
SetupItemID long yes The message's ID to be updated.
Name string no The message's reference name.
Keywords string no The message's comma-separated keywords.
Text string no The message's content in HTML markup or plain text.
Subject string no The message's friendly name, visible to visitors.
Language string id no

The message's language.

  • If not provided, defaults to en.
  • Possible values: de, en, es, fr, it, ja, ko, nl, pt
FolderID long no

The Chat Canned Message folder in which to store the new message.

  • If not provided, defaults to the root Chat Canned Message folder.

Returns:

Parameter Type Description
SetupItemID long The updated message's ID.

deleteChatCannedMessage

Deletes a Chat Canned Message.

Parameter Type Required Description
SetupItemID long yes The message's ID to be deleted.

Returns:

Parameter Type Description
SetupItemID long The deleted message's ID.