Skip to main content
An inbox is a team channel that sends and receives messages. Inboxes usually map to one or more phone numbers or email channels and have their own settings, members, and conversations. When you send a message through the API, you provide the inbox ID that should send the message.

Inbox IDs

Call GET /v1/inboxes before sending messages. The response includes each inbox available to your API credentials. Use the inbox id as inbox_id in message, conversation, and scheduling requests.
curl https://api.heymarket.com/v1/inboxes \
  -H "Authorization: Bearer YOUR_SIGNED_JWT"

Sender IDs

Some write endpoints require creator_id. For message sending, creator_id is the member ID that should appear as the sender. Use a member ID returned by GET /v1/inboxes or GET /v1/team that has access to the target inbox.
Do not assume your general user ID is valid for every inbox. Use a member ID that belongs to the inbox you are sending from.

Multiple inboxes

If your team has multiple inboxes, always pass inbox_id explicitly. This keeps messages, conversations, and scheduled sends associated with the intended channel.

Authentication

Check credentials with GET /v1/inboxes.

Inboxes reference

Review inbox response fields.

Team reference

Retrieve team metadata and member IDs.