Re:amaze
Manage support conversations, messages, and contacts in Re:amaze, a customer support and messaging platform.
Operations
| Operation | Description |
|---|---|
list-conversations |
List conversations filtered by status (open, archived, unassigned, all) |
get-conversation |
Retrieve a single conversation by slug |
create-conversation |
Open a new conversation on behalf of a contact |
reply-to-conversation |
Post a reply or internal note to an existing conversation |
search-contacts |
Search contacts by name or email |
Authentication
Re:amaze uses HTTP Basic Auth. You need:
- Login Email — your Re:amaze account email
- API Token — from your Re:amaze account under Settings > API Token
- Brand Subdomain — the subdomain of your Re:amaze brand (e.g.
mycompanyfrommycompany.reamaze.io)
The API token is passed as the password in Basic Auth alongside your login email.
Input Parameters
| Parameter | Required | Operations | Description |
|---|---|---|---|
apiKey |
Yes | all | Re:amaze API token |
email |
Yes | all | Re:amaze login email |
brand |
Yes | all | Brand subdomain |
operation |
Yes | all | One of the operations above |
filter |
No | list-conversations | open (default), archived, unassigned, all |
page |
No | list-conversations, search-contacts | Page number (default: 1) |
slug |
Yes* | get-conversation, reply-to-conversation | Conversation slug |
subject |
Yes* | create-conversation | Conversation subject |
body |
Yes* | create-conversation, reply-to-conversation | Message text (markdown supported) |
category |
No | create-conversation | Channel slug for the conversation |
contactName |
No | create-conversation | Customer name |
contactEmail |
Yes* | create-conversation | Customer email |
visibility |
No | reply-to-conversation | 0 = regular reply (default), 1 = internal note |
query |
No | search-contacts | Search string for name or email |
*Required for the listed operation.
Examples
List open conversations:
operation: list-conversations
filter: open
Get a specific conversation:
operation: get-conversation
slug: abc123
Create a new conversation:
operation: create-conversation
subject: Billing question
body: Hello, I have a question about my invoice.
contactEmail: [email protected]
contactName: Jane Smith
category: support
Reply to a conversation:
operation: reply-to-conversation
slug: abc123
body: Thanks for reaching out! We'll look into this right away.
visibility: 0
Post an internal note:
operation: reply-to-conversation
slug: abc123
body: Escalate to billing team — customer is on Enterprise plan.
visibility: 1
Search contacts:
operation: search-contacts
query: [email protected]
API Reference
- Base URL:
https://{brand}.reamaze.io/api/v1/ - Docs: https://www.reamaze.com/api
- Rate limited per token per minute; HTTP 429 on excess.