POST /v1/message/send when your integration needs to send a message from a Heymarket inbox. You can send to a phone number, reply in an existing conversation, send to a list, attach media, use a template, or add a private internal comment.
Prerequisites
Before you send a message, collect:- A signed JWT generated from an API Secret.
- The
inbox_idfor the sending inbox. - The
creator_idfor the sender member. - The target, such as
phone_number,chat_id,list_id, ortargets.
Steps
Get the inbox and sender IDs
Call Use a member ID from that inbox, or from
GET /v1/inboxes and choose the inbox that should send the message. Use the inbox id as inbox_id.GET /v1/team, as creator_id.Choose the target
Pick one target family for the send. Do not combine target families in one request.
| Target family | Fields | Use when |
|---|---|---|
| Individual SMS/MMS | phone_number or chat_id | Sending to one phone number or replying inside one conversation. |
| List broadcast | list_id and local_id | Sending separate one-to-one messages to a contact list. |
| Group MMS | targets | Sending one group MMS conversation to multiple phone numbers. |
Send the message
Send the request with
inbox_id, creator_id, a target, and message content from text, template_id, or media_url. Add private: true only when creating an internal comment inside an existing conversation.Examples
Request rules
- Use E.164 digits without the leading plus sign for phone numbers, such as
15105553344. - For an individual SMS or MMS, provide
phone_numberorchat_id. - For broadcasts, provide
list_idand a uniquelocal_id. - For MMS,
media_urlmust be publicly accessible. - For group MMS with
targets, toll-free sending numbers are not supported. - Use
POST /v1/email/sendfor email. Email usestargetsorconvo_id, not the SMS/MMS target fields on this page.
Related pages
Messages
Understand message targets, content, and delivery models.
Send message reference
Review all request fields and response fields.
Message history reference
Retrieve messages for a conversation when you need to verify delivery or replies.
Webhook guide
Receive inbound replies and message events in real time.