POST
/
messages
/
:platform
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.

mediaUrls
array
required

Array of media URLS. Used for images and videos.

URLs of media items should end in the file extension without additional parameters appended.

Facebook and Instagram support multiple media URLs. Twitter only accepts a single media URL.