| Create a message |
POST |
app.animate.io/api/v1/messages |
Important: User ID must belong to a member of the room, or the request will fail.
Required Parameters
| Key |
Value |
| auth_token |
Your platform's auth token |
| room_id |
The id of the room you want to post a message to. |
| user_id |
The id of the user you want the message to be sent from. |
| content |
The content of the message. |
| Index messages for a room |
GET |
app.animate.io/api/v1/rooms/:id |
Required Parameters
| Key |
Value |
| auth_token |
Your platform's auth token |
| Index conversations for a user |
GET |
app.animate.io/api/v1/users/:id/conversations |
Returns all visible conversations for the user, including the latest message, unread count, related transaction status, and related listing information when available.
Important: Use transaction_status for filtering and logic. Use transaction_status_label for visible badge text. The label currently mirrors the status, but can support platform-specific wording without changing integrations.
Required Parameters
| Key |
Value |
| auth_token |
Your platform's auth token |
| id |
The user id whose conversations you want to index. |
Response Fields
| Key |
Value |
| room_id |
The id of the room. |
| url |
The relative URL for the room. |
| image_url |
The related listing image, or the other user's image when no related listing is available. |
| item_title |
The related listing title, or the conversation name when no related listing is available. |
| other_user_name |
The other participant's name. |
| last_message |
The most recent message content. |
| last_message_at_label |
A human-readable timestamp for the latest message. |
| unread_count |
The number of unread messages for the user. |
| transaction_status |
Stable machine-readable status for filtering and logic. One of pending, confirmed, completed, or cancelled. |
| transaction_status_label |
Display label for the status badge. This currently mirrors the status value, but can support platform-specific wording without changing integrations. |