Set conversation status

Change a conversation to active, pending or closed.

PUT https://cotlet.dev/api/v1/help-scout/conversations/{conversation_id}/status

write

Changes the status without sending a reply, as the status control in the conversation does. Closing removes the conversation from the open folders; a new customer email opens it again. Spam is left out on purpose: marking spam teaches Help Scout to send that sender to Spam from then on. The change reaches no customer and one call undoes it, so it does not ask for your OK.

Parameters

Parameters: set_conversation_status
NameTypeDescription
conversation_id integer required integer Conversation number from search_conversations.
status enum required enum active, pending or closed.

Request

cURL
curl -X PUT https://cotlet.dev/api/v1/help-scout/conversations/1/status \
  -H "Authorization: Bearer $COTLET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status":"active"}'
Python
result = client.call("help-scout", "set_conversation_status", {"conversation_id":1,"status":"active"})
Node.js
const result = await cotlet.call('help-scout', 'set_conversation_status', {"conversation_id":1,"status":"active"});
CLI
cotlet call help-scout set_conversation_status --data '{"conversation_id":1,"status":"active"}'

Example response

JSON

{
  "conversation_id": 48190,
  "status": "closed",
  "previous_status": "pending"
}

Sign in once. Your agent does the rest.

Sign up and add the apps you need. Free 7-day trial with 2,000 credits, no card needed.