Skip to main content
An inbox represents a phone number (or email address) that your team uses to send and receive messages. Each inbox has its own set of members, settings, and associated conversations. When you send a message through the API, you specify which inbox it should come from using the inbox_id parameter.

​
The Inbox object

The following attributes are returned when you fetch an inbox from the API.
AttributeDescription
idUnique identifier for the inbox
nameDisplay name of the inbox
teamID of the team this inbox belongs to
membersArray of user IDs who have access to this inbox
phone / phonesHeymarket phone number(s) associated with this inbox
auto_assignableWhether new conversations are automatically assigned to a team member
forward_numberPhone number to forward calls to
widget_codeEmbed code for the Heymarket web widget

​
Retrieving your inbox IDs

Before you can send messages, you need your inbox ID. Retrieve all inboxes available to your account with: 
GET /v1/inboxes
The response returns an array of inbox objects. Use the id field from the inbox you want to send from.
The creator_id parameter when sending messages corresponds to the member ID returned in the members array from the Get Inboxes response — not a user account ID. Make sure you are using a member ID that belongs to the target inbox.

​
Sending messages from an inbox

Pass the inbox_id in your message request body to specify which inbox the message should be sent from: 
{
  "inbox_id": 413,
  "creator_id": 1,
  "phone_number": "14155553434",
  "text": "Hi, how can we help you today?"
}
Always specify inbox_id explicitly when your account has multiple inboxes to ensure messages are sent from the correct number.