This endpoint can be used to send a Direct Message to a Member who is in a 'live' state. For more information about Member States, see our Guide to Member Subscription States.
Phone Number Formatting
Please include and valid 10-digit phone number. We will also accept 11-digits if the leading digit is a 1 for the country code. Our API will accept multiple variations phone number formatting, however, we recommend removing special characters for increased reliability.
Deduplication of Text
If identical text is sent to the samephone_numberwithin a short time period, 30 minutes for SMS, and 10 minutes for WhatsApp, the Community system will automatically deduplicate and not deliver the message. This is in place for experience and compliance reasons.
Please keep this in mind while testing. We recommend varying your text during testing.
Quiet Hours
By default, Community's system enforces Quiet Hours to avoid messaging during unapproved times of day. Any time outside of 11am ET to 8pm ET (US) is considered "Quiet Hours", and messages sent during this time will be queued and sent shortly after the Quiet Hours period ends.To opt-out of this behavior, set the override_quiet_hours parameter to true in your request.
Communication Channel
If you have WhatsApp enabled, and you want to send a direct message via Whatsapp, pass the value communication_channel. Note that this is best effort, and a DM can only be sent if the member is in a 24 hour member-initiated DM window.
Link Wrapping
Any link that is provided in the message text will be wrapped with Community's link wrapper.
Accepted
Bad request
Unauthorized
Forbidden
Unsupported media type