Messages API Overview

The Messaging Add-On is required to access the messages endpoints.

The Messaging Add-On allow you to manage direct messages (DM) to correspondents who contact your User Profiles. A correspondent is the person with whom your user (User Profile) is communicating with. A conversation is a series of messages between your user (User Profile) and their correspondent.

Messaging is available for Facebook Messenger, Instagram Direct Messenger, and X Direct Messages.

​

Key Messaging Features

• Sending text, image, video, and emoji messages.
• Retrieving complete conversation histories.
• Setting up automated message responses.

• Receiving real-time updates via webhooks for messages received, message reactions, read receipts.

​

Enable Messaging for Your Account and User Profiles

You must first enable messaging for your overall Ayrshare account to manage DMs. In the Ayrshare dashboard go to the Account page and click to “Learn More” button and then “Enable”. At this point you have enabled messaging for your overall account, but have not activate messaging for individual User Profiles.

You can activate messaging for individual User Profiles either in the User Profiles page by clicking “Messaging Active” for each profile or using the create or update profiles endpoint.

​

Important Information on Messaging

Monthly Conversation Limit

Each Ayrshare User Profile can have up to 100 active conversations each month. A conversation is considered active for the month if a user or the correspondent has sent as a message. If 100 monthly conversations has been reached you can still receive messages, but will not be able to respond until the start of the month. If you need to increase the monthly conversation limit, please contact your Ayrshare account representative.

You may see the current conversation count with the user endpoint.

​

Message WebHooks

See Messages Webhooks to automatically receive messages, read receipts, or reactions.