Mark a ticket read

.md

Tell the server the team has read what the trader, the assistant and the system wrote.

Scopesadmin:read
Permissionview_tickets
POST/v1/admin/tickets/{ticket}/read

The team has read the conversation: every message from the trader, the assistant and the system that nobody on the team had read yet. It clears unread on the ticket and in the list, for the whole team, as opening a ticket on the website does. Call it when the conversation is on screen, not when the list loads.

It changes what the team has seen, not the ticket, so it takes admin:read like a read. The trader is never told: read receipts only go the other way.

Answers with how many messages it marked. Nothing left to mark answers 0.

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

Request

curl -X POST "https://api.proppertrading.com/v1/admin/tickets/tkt_cbqjrnz84cq45ca7/read" \
  -H "Authorization: Bearer ptat_9f2c1a44_3b8e7d2f5c9a1b4e6d8f0a2c4e6b8d1f" \
  -H "Propper-Workspace: acme" \
  -H "Idempotency-Key: 8b2f4d6a-1c3e-4a5b-9d7f-0e2c4a6b8d1f"

Response

{
    "data": {
        "object": "ticket_read",
        "marked": 1
    },
    "meta": {
        "request_id": "req_01m50typrk5172p2w9ch2nd1wz"
    }
}

Errors

StatusCodeMeaning
400workspace_requiredAsked by our own staff without naming a firm
400missing_idempotency_keyA POST without an Idempotency-Key header
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:read
403workspace_not_permittedThe Propper-Workspace header names an environment this account cannot act in
403forbiddenWithout view_tickets
404resource_not_foundNo ticket with that id in this firm