Messages
AI agents: read /llms.txt; add .md to any page URL. This page as Markdown: /reference/messages.md. Index of every page and the rules for every call: /llms.txt. Guides and concepts in one file: /llms-full.txt. OpenAPI: /openapi.json.
Your team's whole message inbox: emails and texts exchanged with customers and vendors on all sales orders, quotes and purchase orders, with their delivery status. Read them, retry failed deliveries and set a message status here. To send a message on one order, use Sales order messages.
8 operations
- GETList messages
/Lists the messages on your team's sales orders, quotes and purchase orders, newest first: emails and texts you sent to customers and vendors, and the replies they sent back.v2/ api/ store/ {team_slug}/ messages - GETList a message's recipients
/Lists everyone a message was sent to, with how delivery went for each: the address or number it went to at the time, the channel (v2/ api/ store/ {team_slug}/ messages/ {hash_id}/ recipients emailorsms), the status, and the provider's error when it failed. - POSTFilter messages
/Lists messages likev2/ api/ store/ {team_slug}/ messages/ filter GET /v2/api/store/{team_slug}/messages, narrowed by direction or status, with an optional sort. - GETGet a message
/Returns one message in full: the message as written (v2/ api/ store/ {team_slug}/ messages/ {hash_id} message), the whole message as HTML (original_message), attachments, recipients with their delivery status, its team status, andretryable, which says whether a failed delivery can… - GETGet one recipient of a message
/Returns one recipient's delivery: where it was sent, the channel, the status and any provider error.v2/ api/ store/ {team_slug}/ messages/ {hash_id}/ recipients/ {id} - PUTRetry delivery to one recipient
/Sends the message again to one recipient whose delivery failed.v2/ api/ store/ {team_slug}/ messages/ {hash_id}/ recipients/ {id}/ retry - PUTRetry a message's failed deliveriesSpends money
/Sends an outbound message again to the recipients it failed to reach.v2/ api/ store/ {team_slug}/ messages/ {hash_id}/ retry - PUTSet a message's status
/Sets your team's own status on a message, such as "Need to Respond" or "Completed", for sorting your inbox.v2/ api/ store/ {team_slug}/ messages/ {hash_id}/ status