Update Help Scout Conversation Status

Changes the status of a Help Scout conversation, for example to reopen it.

Unverified

Add this first. This tool needs an access token, so add Get Help Scout Access Token to the same bot. The bot calls it first and passes the token in.

What the model is told

Get a Help Scout access token first if you do not already have one. Change the status of an existing conversation. Use active to reopen it, pending to mark it as waiting, or closed when the customer confirms the matter is resolved. Confirm the conversation ID and new status with the customer first. A successful call returns no body.

Request

PATCHhttps://api.helpscout.net/v2/conversations/{{conversationId}}

Headers

Content-Typeapplication/json
AuthorizationBearer {{accessToken}}

Body

{
  "op": "replace",
  "path": "/status",
  "value": "{{status}}"
}

Parameters

conversationId stringThe Help Scout conversation ID (not the conversation number).
status stringThe new status: active, pending or closed.
accessToken stringThe access_token value returned by Get Help Scout Access Token. Reuse it for the rest of the conversation.

Engage payload

{
  "source": "VOICE_AI",
  "tool": {
    "id": "a82f80e1-fc32-49f3-aeb1-dc14b491bc1e",
    "type": "HTTP_REQUEST",
    "label": "Update Help Scout Conversation Status",
    "name": "update_help_scout_conversation_status",
    "customName": false,
    "description": "Get a Help Scout access token first if you do not already have one. Change the status of an existing conversation. Use active to reopen it, pending to mark it as waiting, or closed when the customer confirms the matter is resolved. Confirm the conversation ID and new status with the customer first. A successful call returns no body.",
    "parameters": [
      {
        "name": "conversationId",
        "type": "string",
        "description": "The Help Scout conversation ID (not the conversation number)."
      },
      {
        "name": "status",
        "type": "string",
        "description": "The new status: active, pending or closed."
      },
      {
        "name": "accessToken",
        "type": "string",
        "description": "The access_token value returned by Get Help Scout Access Token. Reuse it for the rest of the conversation."
      }
    ],
    "config": {
      "endpoint": {
        "method": "PATCH",
        "url": "https://api.helpscout.net/v2/conversations/{{conversationId}}"
      },
      "headers": [
        {
          "name": "Content-Type",
          "value": "application/json"
        },
        {
          "name": "Authorization",
          "value": "Bearer {{accessToken}}"
        }
      ],
      "body": "{\n  \"op\": \"replace\",\n  \"path\": \"/status\",\n  \"value\": \"{{status}}\"\n}",
      "timeout": null
    }
  }
}

IDs are regenerated on every copy.