POST
/
messages
/
:platform
curl \
-H "Authorization: Bearer API_KEY" \
-H 'Content-Type: application/json' \
-d '{"message": "What's up!", "recipientId": "283j839222"} \
-X POST https://api.ayrshare.com/api/messages/instagram

{ // single text message
    "status": "success",
    "recipientId": "72706337063589124",
    "messageId": "aWdfZAG1faXRlbToxOkl",
    "message": "What is up?"
}
Available on Business, Enterprise plans.
Send a new direct message to a recipient.
  • You can send an emoji as part of the message text.
  • Facebook and Instagram mediaUrls must end in a known extension. Including query parameters will cause the media url to fail.

​
Header Parameters

​
Authorization
string
required
API Key of the Primary Profile.

Format: Authorization: Bearer API_KEY
​
Profile-Key
string
Profile Key of a User Profile.

Format: Profile-Key: PROFILE_KEY

​
Path Parameters

​
platform
string
required
The platform to send the message: facebook, instagram, twitter

​
Body Parameters

​
recipientId
string
required
The ID of the message recipient.
​
message
string
required
The message to send to the recipient.
  • Facebook and Instagram message may be an empty string or not included if a mediaUrls is provided.
  • X requires a message of at least one character even if a mediaUrls is provided.
​
mediaUrls
array
Array of media URLS for attaching images and a video.
  • URLs of media items should end in the file extension without additional parameters appended.
  • Facebook and Instagram support multiple media URLs.
  • X only accepts a single media URL.
curl \
-H "Authorization: Bearer API_KEY" \
-H 'Content-Type: application/json' \
-d '{"message": "What's up!", "recipientId": "283j839222"} \
-X POST https://api.ayrshare.com/api/messages/instagram

{ // single text message
    "status": "success",
    "recipientId": "72706337063589124",
    "messageId": "aWdfZAG1faXRlbToxOkl",
    "message": "What is up?"
}