Skip to main content
POST
Use this endpoint to send messages from a Heymarket inbox. It supports individual messages, list broadcasts, MMS media, templates, surveys, and private internal comments.
creator_id is the member ID returned by GET /v1/inboxes or GET /v1/team, not necessarily your general user ID.
local_id is required when sending a broadcast with list_id. Use a unique value per broadcast send.

Authorizations

​
Authorization
string
header
required

Recommended authentication for new integrations. Generate a short-lived JWT from your API Secret ID and API Secret Key, then pass the signed JWT as a bearer token in the Authorization header.

API Secret credentials are available in the Heymarket app under Settings > Integrations > API. The Secret Key is shown only when it is generated, so copy and store it securely before closing the dialog.

Use the following JWT values:

Replace CURRENT_UNIX_TIMESTAMP with the current Unix timestamp in seconds when generating the token.

Sign the JWT with HMAC-SHA256 using this signing secret:

Send the signed JWT as a bearer token:

Tokens expire 5 minutes after the iat timestamp. Generate a new JWT per request, or cache it briefly for less than 5 minutes. Generate JWTs only from trusted server-side code; do not expose the API Secret Key in browser, mobile, or other client-side code.

Body

application/json

Message send json

​
creator_id
integer
required
​
inbox_id
integer
required
​
activity_id
string
​
author
string
​
attachments
object[]
​
chat_id
integer
​
conv_name
string
​
creator_email
string
​
custom
object
​
gallery
object[]
​
link_url
string
​
list_id
integer
​
local_id
string
​
media_url
string
​
notify_all
boolean
​
opt_in
boolean
​
phone_number
string
​
prefer_contact_owner
boolean
​
private
boolean
​
survey_id
integer
​
targets
string[]
​
template_id
integer
​
text
string
​
to
string
​
raw_text
string
​
user_ids
integer[]

Response

OK

​
date
string
​
gallery_url
string
​
id
integer