> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/re-amaze.md).

# Re:amaze

Re:amaze is a customer support platform for conversations, contacts, messages, and help desk workflows.

## Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Re:amaze  | Credentials    |

### Re:amaze

Connect to Re:amaze with a brand, login email, and API token.

#### Set up in Re:amaze

1. Sign in to Re:amaze and go to Settings → Developer → API Token.
2. Click Generate New Token and copy the API token (treat it like a password).

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **Re:amaze**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                        |
| ------------- | -------- | ---------------------------------------------------------------------------------------------------- |
| Brand         | Yes      | Your Re:amaze brand subdomain from https\://\<brand>.reamaze.io.                                     |
| Login Email   | Yes      | The Re:amaze user email that owns the API token.                                                     |
| API Token     | Yes      | The API token generated for the Re:amaze user. [Provider instructions](https://www.reamaze.com/api). |

**Provider documentation:** [Setup reference](https://www.reamaze.com/api).

### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

## Use an action

1. Add the required **Re:amaze** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

## Actions

### Create Conversation

Create a new conversation in Re:amaze.

#### Inputs

| Field                  | Type            | Required | Description                                                                                                                                                   |
| ---------------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Subject                | string          | Yes      | Conversation subject.                                                                                                                                         |
| Channel                | string          | Yes      | Re:amaze channel slug.                                                                                                                                        |
| Message                | textarea        | Yes      | Initial customer message body.                                                                                                                                |
| Customer Email         | string          | Yes      | Customer email address.                                                                                                                                       |
| Customer Name          | string          | No       | Optional customer name.                                                                                                                                       |
| Tags                   | array           | No       | Optional tags to apply.                                                                                                                                       |
| Status                 | select (string) | No       | Optional initial conversation status. Available values: Open, Responded, Done, Spam, Archived, On Hold, Auto Done, Ai Agent Assigned, Ai Agent Done, Ai Spam. |
| Assignee Email         | string          | No       | Optional staff assignee email.                                                                                                                                |
| Recipients             | array           | No       | Optional message recipients.                                                                                                                                  |
| Suppress Notifications | boolean         | No       | Suppress Re:amaze notifications for the initial message.                                                                                                      |
| Conversation Data      | object          | No       | Optional custom conversation data.                                                                                                                            |
| Customer Data          | object          | No       | Optional custom customer data.                                                                                                                                |

#### Outputs

| Field        | Type    | Description                   |
| ------------ | ------- | ----------------------------- |
| Slug         | string  | Created conversation slug.    |
| Subject      | string  | Created conversation subject. |
| Status       | integer | Conversation status.          |
| Conversation | dict    | Raw created conversation.     |

### Create Message

Create a message in a Re:amaze conversation.

#### Inputs

| Field                  | Type            | Required | Description                                                               |
| ---------------------- | --------------- | -------- | ------------------------------------------------------------------------- |
| Conversation Slug      | string          | Yes      | Slug of the conversation to reply to.                                     |
| Body                   | textarea        | Yes      | Message body.                                                             |
| Visibility             | select (string) | No       | Message visibility. Available values: Regular, Internal Note. Default: 0. |
| Sender Email           | string          | No       | Optional sender/customer email.                                           |
| Sender Name            | string          | No       | Optional sender/customer name.                                            |
| Origin ID              | string          | No       | Optional idempotency/origin identifier.                                   |
| Recipients             | array           | No       | Optional recipient emails.                                                |
| Suppress Notifications | boolean         | No       | Suppress Re:amaze notifications.                                          |
| Suppress Autoresolve   | boolean         | No       | Suppress automatic resolution.                                            |
| Attachment URL         | string          | No       | Optional attachment URL.                                                  |

#### Outputs

| Field             | Type    | Description           |
| ----------------- | ------- | --------------------- |
| Body              | string  | Created message body. |
| Visibility        | integer | Message visibility.   |
| Conversation Slug | string  | Conversation slug.    |
| Message           | dict    | Raw created message.  |

### Update Conversation

Update a Re:amaze conversation.

#### Inputs

| Field             | Type            | Required | Description                                                                                                                                               |
| ----------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Conversation Slug | string          | Yes      | Slug of the conversation to update.                                                                                                                       |
| Status            | select (string) | No       | Optional new conversation status. Available values: Open, Responded, Done, Spam, Archived, On Hold, Auto Done, Ai Agent Assigned, Ai Agent Done, Ai Spam. |
| Assignee Email    | string          | No       | Optional staff assignee email.                                                                                                                            |
| Tags              | array           | No       | Optional replacement tag list.                                                                                                                            |
| Hold Until        | string          | No       | Optional hold-until timestamp.                                                                                                                            |
| Channel           | string          | No       | Optional channel slug.                                                                                                                                    |
| Brand             | string          | No       | Optional target Re:amaze brand.                                                                                                                           |
| Conversation Data | object          | No       | Optional custom conversation data.                                                                                                                        |

#### Outputs

| Field        | Type    | Description                   |
| ------------ | ------- | ----------------------------- |
| Slug         | string  | Updated conversation slug.    |
| Subject      | string  | Updated conversation subject. |
| Status       | integer | Conversation status.          |
| Conversation | dict    | Raw updated conversation.     |

### List Conversations

List conversations in Re:amaze.

#### Inputs

| Field          | Type            | Required | Description                                                                      |
| -------------- | --------------- | -------- | -------------------------------------------------------------------------------- |
| Page           | integer         | No       | Page number to fetch. Minimum: 1. Default: 1.                                    |
| Filter         | select (string) | No       | Optional conversation filter. Available values: Archived, Open, Unassigned, All. |
| Sort           | select (string) | No       | Optional sort mode. Available values: Updated, Changed.                          |
| Tag            | string          | No       | Optional tag filter.                                                             |
| Channel        | string          | No       | Optional channel/category filter.                                                |
| Customer Email | string          | No       | Optional customer email filter.                                                  |
| Start Date     | string          | No       | Optional start date.                                                             |
| End Date       | string          | No       | Optional end date.                                                               |
| Origin         | string          | No       | Optional origin filter.                                                          |

#### Outputs

| Field         | Type        | Description                       |
| ------------- | ----------- | --------------------------------- |
| Conversations | dict\_array | Returned conversations.           |
| Total Count   | integer     | Total matching conversations.     |
| Page Size     | integer     | Page size returned by Re:amaze.   |
| Page Count    | integer     | Page count returned by Re:amaze.  |
| Has More      | boolean     | Whether more pages are available. |

### Get Customer

Look up a Re:amaze customer by email.

#### Inputs

| Field | Type   | Required | Description             |
| ----- | ------ | -------- | ----------------------- |
| Email | string | Yes      | Customer email to find. |

#### Outputs

| Field         | Type        | Description                             |
| ------------- | ----------- | --------------------------------------- |
| Found         | boolean     | Whether an exact email match was found. |
| Email         | string      | Matched customer email.                 |
| Name          | string      | Matched customer name.                  |
| Friendly Name | string      | Matched customer friendly name.         |
| Customer      | dict        | Raw matched customer.                   |
| Contacts      | dict\_array | Contacts returned by the search.        |
| Total Count   | integer     | Total contacts reported by Re:amaze.    |

## Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/re-amaze.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
