Profile pages are HTML pages that provide metadata to operators when answering chats. Both folders and queues can have profiles, and you can use these together to build a streamlined set of metadata to assist your operators.
Profile pages are free-form HTML. In most cases, you will provide more generic content at the folder level and more specific content at the queue level. When using the LibraryH3lp webchat client, the profile page shown to your operators during a chat will pull all of the data for the relevant queue and its containing folder(s). For example, you might have a shared password that all operators on many queues need to know. You could provide the password in the top-level folder profile, so that the password would be available for all queues inside that folder. Also, this way the password is only stored (and only needs to be updated) in one profile instead of in several.
LibraryH3lp supports cookie-based authentication. To learn more, you can read the details on authentication.
Requests are served over HTTPS. To ensure data privacy, unencrypted HTTP is not supported.
/2011-12-03/folders/{FolderId}/profiles/staff
Retrieve the profile page for a given folder.
Returns the profile page as an HTML response.
GET /2011-12-03/folders/5559/staff
<p>
Example text for a folder profile.
</p>
Not supported.
Allows you to modify a folder's profile.
You must include, as raw PUT data, the folder's HTML profile.
Returns a JSON response with the following properties:
| Property | Description |
|---|---|
| success | Boolean indicating if the request was successful. |
| message | Optional. If success is null, message is a string describing the reason for the failed request. |
PUT /2011-12-03/folders/5559/staff
<p>
Completely different text for this folder profile.
</p>
{
"success": true
}
Not supported.
/2011-12-03/queues/{QueueName}/profiles/staff
Retrieve the profile page for a given queue.
Returns the profile page as an HTML response.
GET /2011-12-03/queues/example-queue/profiles/staff
<p>
This is some paragraph text for an example queue profile.
</p>
Not supported.
Allows you to modify a queue's profile.
You must include, as raw PUT data, the queue's HTML profile.
Returns a JSON response with the following properties:
| Property | Description |
|---|---|
| success | Boolean indicating if the request was successful. |
| message | Optional. If success is null, message is a string describing the reason for the failed request. |
PUT /2011-12-03/queues/example-queue/profiles/staff
<p>
Completely different text for this queue profile.
</p>
{
"success": true
}
Not supported.