When you configure an export, import, or other type of flow step using the prebuilt Hootsuite connector, you can select any of the API operations listed below*, organized by API type.
Note
If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Hootsuite API documentation. You can also create a composite endpoint for this application in HTTP mode.
|
APIs |
Resource |
API endpoint |
Export |
Import |
|---|---|---|---|---|
|
Platform rest |
Messages |
Retrieve outbound messages |
X |
|
|
Schedule messages |
X |
|||
|
Retrieve message |
X |
|||
|
Delete message |
X |
|||
|
Approve message |
X |
|||
|
Reject message |
X |
|||
|
Get message review history |
X |
|||
|
Comments |
Retrieve comment |
X |
||
|
Approve comment |
X |
|||
|
Reject comment |
X |
|||
|
Media library |
Media |
Retrieve media upload status |
X |
|
|
Social profiles |
Retrieve social profiles |
X |
||
|
Retrieve social profile |
X |
|||
|
Retrieve social profile's teams |
X |
|||
|
Members |
Retrieve member |
X |
||
|
Create member |
X |
|||
|
Retrieve member's organizations |
X |
|||
|
Me |
Retrieve authenticated member |
X |
||
|
Retrieve authenticated member's organizations |
X |
|||
|
Retrieve authenticated member's social profiles |
X |
|||
|
Organizations |
Retrieve organization teams |
X |
||
|
Retrieve organization members |
X |
|||
|
Remove member from organization |
X |
|||
|
Retrieve org member's organization permissions |
X |
|||
|
Retrieve org member's teams |
X |
|||
|
Retrieve org member’s social profiles |
X |
|||
|
Retrieve org member’s social profile permissions |
X |
|||
|
Teams |
Create team |
X |
||
|
Add member to team |
X |
|||
|
Retrieve team members |
X |
|||
|
Retrieve team member's permissions |
X |
|||
|
Retrieve org team’s social profiles |
X |
|||
|
Retrieve team |
X |
|||
|
SCIM (2.0) |
Get users |
X |
||
|
Create user |
X |
|||
|
Get user |
X |
|||
|
Replace user |
X |
|||
|
Modify user |
X |
|||
|
Get groups |
X |
|||
|
Create group |
X |
|||
|
Get group |
X |
|||
|
Replace group |
X |
|||
|
Modify group |
X |
|||
|
Get resource types |
X |
|||
|
Interactions |
Get interactions |
X |
||
|
Media |
Retrieve media |
X |
||
|
Status |
Status check |
X |
||
|
Inbox |
Real time metrics |
Inbound message volume |
X |
|
|
Outbound message volume |
X |
|||
|
Average first response time |
X |
|||
|
Average conversation response time |
X |
|||
|
Resolved with reply |
X |
|||
|
Average handle time |
X |
|||
|
Agent availability |
X |
|||
|
Contacts waiting in queue |
X |
|||
|
Longest wait time in queue |
X |
|||
|
User presence |
Online agents |
X |
||
|
Virtual agent |
Manipulate conversation |
X |
||
|
Queue |
Conversation locked by an agent |
X |
||
|
Proactive messaging |
Send proactive message |
X |
||
|
Get status |
X |
|||
|
Get status detail |
X |
|||
|
CRM |
Set contact attributes |
X |
||
|
Sparkcentral |
Proactive |
Send a proactive message |
X |
|
|
Get the status overview for a sent proactive message |
X |
|||
|
Get the details of the failed messages |
X |
|||
|
Real-time metrics |
Inbound message volume |
X |
||
|
Outbound message volume |
X |
|||
|
Average first response time |
X |
|||
|
Average First Response Time |
X |
|||
|
Resolved With Reply |
X |
|||
|
Average Handle Time |
X |
|||
|
Agent Availability |
X |
|||
|
Contacts waiting in queue |
X |
|||
|
Longest wait time in queue |
X |
|||
|
Get organization User |
X |
|||
|
Get organization team |
X |
|||
|
Get channels |
X |
|||
|
List of all currently online agents |
X |
|||
|
Virtual agent |
Manipulate conversation |
X |
||
|
Queue |
Conversation locked by an agent |
X |