Put a conversation on hold
POST/conversations/:conversation_id/hold
Park a conversation until a deadline. It leaves the active queues and comes back by itself when the timer expires — or sooner, if the customer writes in.
The assignment is deliberately left alone: on hold means "come back to me later", so the conversation returns to the same agent.
until is read in the account's timezone (Settings → General), never the
caller's, because a deadline is business logic rather than a display preference.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 409
The conversation, now on hold.
Response Headers
Correlation id for this request. Quote it when reporting a problem.
The request was malformed, or a parameter was rejected.
Response Headers
Correlation id for this request. Quote it when reporting a problem.
No token, an expired token, or a credential that has been revoked.
Response Headers
Correlation id for this request. Quote it when reporting a problem.
Refused. Either the credential does not hold the scope this endpoint needs (code: insufficient_scope), or the account's IP allow-list does not include the calling address (code: ip_not_allowed).
Response Headers
Correlation id for this request. Quote it when reporting a problem.
No such resource in this account.
Response Headers
Correlation id for this request. Quote it when reporting a problem.
The request was valid but conflicts with the current state.
Response Headers
Correlation id for this request. Quote it when reporting a problem.