VYG Docs
Concepts

Conversation pause

Pause the brand's agents and automated replies for a customer while your help desk handles them.

When your help desk takes over a customer, pause their conversation so the customer does not get two answers. A pause applies to the customer's contact (their phone number), so it covers every conversation the brand has with that customer. While a customer is paused:

  • the brand's agents do not pick them up, and their conversations do not enter the agent queue (pausing takes a waiting conversation out of the queue);
  • assignment rules do not assign their conversations;
  • reply flows and off-hours auto-replies do not start (a reply-flow message that was already scheduled before the pause still sends);
  • blasts and other flows (for example abandoned checkout) still send;
  • replies you send through the API still go out;
  • customer texts still arrive, message.received still fires, and STOP still opts the customer out.

Brand users and agents see a Paused label on the conversation.

Resume the conversation when your ticket closes. A pause also ends by itself after 7 days.

Who can call this

An API key or sign-in token that includes conversations:pause. Create a key in Settings → API keys and turn on Pause conversations; no preset grants it. The feature is turned on per brand with the beta:messaging-api permission; without it the endpoints answer 403 feature_not_enabled. Pausing is REST only and is not exposed as an MCP tool.

Pause, resume and status

curl -X POST "https://api.vyg.app/v1/conversations/{id}/pause" \
  -H "Authorization: Bearer $VYG_API_KEY"
{
	"conversation_id": "0c000000-0000-4000-8000-000000000001",
	"paused": true,
	"paused_until": "2026-11-24T12:00:00.000Z"
}
curl -X POST "https://api.vyg.app/v1/conversations/{id}/resume" \
  -H "Authorization: Bearer $VYG_API_KEY"

curl "https://api.vyg.app/v1/conversations/{id}/pause" \
  -H "Authorization: Bearer $VYG_API_KEY"

All three return the same shape. paused_until is null when the customer is not paused.

Pausing a paused customer moves paused_until to 7 days from now. Resuming a customer who is not paused returns "paused": false and changes nothing.

When you resume, a customer whose last text nobody answered goes back into the agent queue, so a ticket your help desk closed without replying is not left unanswered. Automatic system messages do not count as an answer.

When a pause ends by itself

A pause lasts 7 days. Each reply you send through the API to a paused customer moves paused_until to 7 days after that reply, so a pause stays on while your help desk is working the ticket.

Once paused_until passes, the customer is no longer paused. Their next text goes to the agent queue and can start reply flows as usual. A text they sent during the pause that nobody answered is not put back in the queue when the pause runs out; resume the conversation if you want that.

Failures

Statuserror.codeWhen
403insufficient_scopeThe credential lacks conversations:pause.
403feature_not_enabledThe brand does not have the messaging API turned on.
404conversation_not_foundNo conversation with that id for this brand.

On this page