Block the assistant on a ticket

.md

Take the /ai command away from the trader on one ticket, or give it back.

Scopesadmin:write
Permissionview_ticketsmanage_tickets
PUT/v1/admin/tickets/{ticket}/ai-block

Blocking takes the /ai command away from the trader, so they cannot switch the assistant back on for this ticket. Use it when somebody keeps flipping the conversation back to the assistant, or when a case is too delicate for it.

Blocking a ticket the assistant is still answering hands it to the team on the spot: the assistant goes off, the ticket moves to awaiting_admin, and the trader reads a line in the thread saying so, with the event ai_blocked.

Allowing it again only gives the trader the command back. It does not switch the assistant on. The team's own request for a reply works either way: the block is about who may call the assistant in.

Answers with the ticket, with ai_blocked and ai_enabled as they are now.

Needs a firm. Our own staff name one with the Propper-Workspace header.

Request

FieldDescription
blockedtrue to block, false to allow. Required
curl -X PUT "https://api.proppertrading.com/v1/admin/tickets/tkt_cbqjrnz84cq45ca7/ai-block" \
  -H "Authorization: Bearer ptat_9f2c1a44_3b8e7d2f5c9a1b4e6d8f0a2c4e6b8d1f" \
  -H "Propper-Workspace: acme" \
  -H "Content-Type: application/json" \
  -d '{"blocked": true}'

Response

The ticket, now with "ai_blocked": true.

Errors

StatusCodeMeaning
400workspace_requiredAsked by our own staff without naming a firm
401invalid_tokenNot a token, or the secret does not match
401revoked_tokenSigned out here or from another device
401expired_tokenNinety days without use, or a set expiry passed
403admin_access_requiredThis account no longer helps run the environment
403insufficient_scopeThis device does not hold admin:write
403workspace_not_permittedThe Propper-Workspace header names an environment this account cannot act in
403forbiddenWithout view_tickets and manage_tickets
404resource_not_foundNo ticket with that id in this firm
409ticket_endedThe ticket was resolved or closed
422validation_failedNo blocked, or not a boolean