Skip to main content
POST
/
v1
/
message
/
send
curl --request POST \
  --url https://api.heymarket.com/v1/message/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "creator_id": 1,
  "inbox_id": 1,
  "phone_number": "16505551003",
  "text": "My first api message",
  "local_id": "6d8d0429-3f15-4293-8d0b-38bf1dd5ca06"
}
'
{
  "date": "<string>",
  "gallery_url": "<string>",
  "id": 123
}
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:

{
  "alg": "HS256",
  "typ": "JWT"
}
{
  "iss": "YOUR_API_SECRET_ID",
  "iat": CURRENT_UNIX_TIMESTAMP
}

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:

YOUR_API_SECRET_ID||YOUR_API_SECRET_KEY

Send the signed JWT as a bearer token:

Authorization: Bearer YOUR_SIGNED_JWT

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

​
activity_id
string
​
author
string
​
chat_id
integer
​
creator_id
integer
​
inbox_id
integer
​
list_id
integer
​
local_id
string
​
media_url
string
​
phone_number
string
​
private
boolean
​
survey_id
integer
​
targets
string[]
​
template_id
integer
​
text
string

Response

OK

​
date
string
​
gallery_url
string
​
id
integer