Skip to main content
Re:amaze logo
  • Category: customer support
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 9
  • Triggers: 0
  • Slug: RE_AMAZE
  • Version: 20261021_00

Tools

Slug: RE_AMAZE_GET_CONTACT_BY_EMAILRetrieve a Re:amaze contact by an exact email-address match.

Input Parameters

string
required
Exact contact email address to look up.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RE_AMAZE_GET_CONVERSATIONRetrieve one Re:amaze conversation by its supported identifier.

Input Parameters

string
Optional channel type used with id_type origin
string ("ref" | "origin")
How to interpret conversation_id; omit for slug lookup with database-ID fallback
string
Category slug; required when id_type is origin
string
required
Conversation slug by default; a reference ID when id_type is ref, an origin ID when id_type is origin, or a database ID when slug lookup fails

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RE_AMAZE_GET_REPORTS_TAGSTool to retrieve a list of tags used in reports. Use when analyzing tag usage metrics across conversations.

Input Parameters

string
Report end date in YYYY-MM-DD format
string
Report start date in YYYY-MM-DD format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RE_AMAZE_GET_RESPONSE_TEMPLATESTool to retrieve response templates for the brand. Use when you need canned responses to streamline replies.

Input Parameters

string
Search query to filter response templates by keywords
integer
Page number for pagination through results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RE_AMAZE_GET_STAFF_PERFORMANCE_REPORTRetrieve staff performance metrics for a Re:amaze report period.

Input Parameters

string
Brand URL to filter; omit to include all account brands.
string
Report end date in YYYY-MM-DD format.
string
Report start date in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RE_AMAZE_LIST_ARTICLESList and search Re:amaze Help Center articles.

Input Parameters

integer
One-based results page.
string
Keyword query used to search articles.
string ("published" | "draft" | "internal")
Article visibility status to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RE_AMAZE_LIST_CONTACT_IDENTITIESRetrieve the identities linked to a Re:amaze contact email.

Input Parameters

string
required
Email address of the contact whose identities to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RE_AMAZE_LIST_CONVERSATIONSLists Re:amaze conversations with optional status, order, and date filters.

Input Parameters

string
Comma-separated tags that matching conversations must have
object
Conversation data key-value pairs to match
integer
One-based results page
string ("updated" | "changed")
Sort by latest customer update or latest change; omit to sort by creation time
string ("archived" | "open" | "unassigned" | "all")
Conversation status group; omit to return unarchived conversations
string
Return conversations relevant to this customer SSO ID
string
Conversation origin code or name to match
string
Channel category slug to match
string
ISO 8601 upper bound for latest customer message time
string
Return conversations relevant to this user email
string
ISO 8601 lower bound for latest customer message time

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RE_AMAZE_LIST_MESSAGESList messages across a Re:amaze brand or within one conversation.

Input Parameters

string
Comma-separated conversation tags to match
integer
One-based results page
string ("staff" | "customer")
Return only staff or customer messages
integer
Numeric message origin code to match
string
Include each message’s original HTML body
string
Known user email that sent the messages
string
Channel category slug to match
string
ISO 8601 upper bound for message creation time
string
ISO 8601 lower bound for message creation time
string
Conversation slug to scope results; omit for all brand messages

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not