Built by Metorial, the integration platform for agentic AI.
Retrieve all notes attached to a specific contact, including their canonical noteIdentifier values for updates and deletion. The contact is identified by email or phone number.
Create a new support conversation with a subject, message body, customer info, and channel assignment. Optionally set tags, status, and staff assignment.
Update an existing conversation's status, assignee, tags, channel, or custom fields. Use this to reassign, resolve, reopen, tag, or move conversations.
Create a new staff user account in your Re:amaze account. This can increase your monthly subscription cost. Re:amaze does not send an invitation email, and the user must change their password at first login.
Create a new knowledge base / FAQ article. Set the title, body content, publication status, and optionally assign it to a topic.
Retrieve customer satisfaction ratings. Filter by rating value, staff member, brand, or creation/update date range. Ratings cover all account brands by default. Requires the `access_reports` permission.
List and search pre-written response templates. Use the query parameter to search by keyword.
List and search knowledge base articles. Filter by status (published, draft, internal), search by keyword, or scope to a specific topic.
Create a new status page incident with a title, initial status update, and optionally associate affected systems with their operational status.
List and filter support conversations. Supports filtering by status (open, archived, unassigned), date range, tags, channel, origin, and customer. Results are paginated.
Update an existing response template's name, body content, or personal/shared setting.
Create a new customer contact record with a name and either an email address or mobile phone number (E.164 format). Optionally set custom attributes and notes.
Create a new pre-written response template for staff to use when replying to conversations.
Search and list customer contacts across the account. Supports searching by name or email, filtering by contact type (email or mobile), and custom attribute matching. Results are paginated.
Update an existing knowledge base article's title, body, status, or topic assignment.
Retrieve support analytics reports. Available report types: - **volume**: Daily conversation volume counts - **response_time**: Response time metrics and summaries (in seconds) - **staff**: Staff performance metrics - **tags**: Tag usage reports - **channel_summary**: Aggregated metrics by channel Reports cover all brands in the account by default. Filter by brand and date range. Dates default to the last 30 days; the range must span at least one day and no more than one year.
Update an existing status page incident. Add new status updates, change the title, or update associated system statuses. This is also how you add follow-up updates to an incident.
Add a new note to a specific contact. The contact is identified by email or phone number.
Retrieve a page of staff members in your Re:amaze account. Useful for finding staff emails needed when assigning conversations. Use pageCount to retrieve every page.
Add a reply or internal note to an existing conversation. Set visibility to control whether the message is a public reply (visible to the customer) or an internal note (staff-only).
Retrieve a conversation summary by slug, reference ID, or origin ID, including the initial message, latest customer and staff messages, tags, assignee, and customer information. Use list_messages to retrieve the message history.
Update an existing contact's name, friendly name, avatar, custom attributes, or add new notes. Contacts are identified by email, mobile, or social identifier.
Delete a specific note from a contact. Provide the contact identifier and noteIdentifier returned by list_contact_notes.
Retrieve all systems configured on the status page. Useful for finding system IDs needed when creating or updating incidents.
List status page incidents. Optionally filter to show only active (unresolved) incidents.
List all configured support channels for the brand. Optionally filter by channel type (email, facebook, twitter, chat). Useful for finding channel slugs needed when creating conversations.
Retrieve a support channel by its slug, including its type, sender settings, signature, verification state, and brand. Call list_channels to discover channel slugs.
List the email, mobile, and social identities associated with a contact identified by email.
Retrieve a knowledge base article by its slug, including its content, publication status, author, and topic. Call list_articles to discover article slugs.
Update a specific contact note. Call list_contact_notes for the contact and pass the noteIdentifier returned for the note.
Associate an email, mobile, Twitter, or Instagram identity with an existing contact. If the identity belongs to another contact, its messages and data move to this contact.
Retrieve a response template by its ID, including its content and group. Call list_response_templates to discover template IDs.
Retrieve one page of messages, newest first, across the current brand or within a conversation. Includes customer messages, staff replies and internal notes, sender and recipient information, and file metadata.
Retrieve a status page incident by ID, including its updates and affected systems. Call list_incidents to discover incident IDs and existing system association IDs.
Associate an email, mobile, Twitter, or Instagram identity with an existing contact identified by a mobile number or social identity. Use create_contact_identity when the contact is identified by email.