Mark a conversation read
- Credentials
- OAuth access token
- Scopes
messages:read- Subscription
- Needs an active plan. Otherwise
403 subscription_locked. - Idempotency
- Send an
Idempotency-Keyheader. A retry with the same key does the work once.
Needs messages:read. Write-gated, unlike notifications/read.
Access: OAuth scope messages:read (a grant with messages:send passes too); write-gated by the subscription.
merchantOAuth messages:readAuthorizationBearer <token>OAuth 2.1 (authorization code + PKCE S256, public clients, dynamic registration) for connected AI apps. Effective power is scopes granted AND the person's role today AND the plan. orders:refund, billing:write and team:write are opt-in on the consent screen. Write implies read for marketing:read and messages:read, so a grant holding marketing:write passes a marketing:read check, and messages:send passes messages:read.
Scope: messages:read
storeId*stringA store the person can reach. Any other id answers 404, never 403.
threadId*stringThe customer's WhatsApp id (phone digits).
Idempotency-Key*stringRequired on every write. Minted on the device when the person taps, reused on every retry. A write without one, or with one that does not match the pattern, is refused with 422 validation_error. Scoped to the token's subject, remembered 24 hours. A replay returns the first 2xx response with Idempotent-Replay: true; a request still running answers 409 in_flight; the same key with a different method, path or body answers 409 idempotency_key_reused; non-2xx results are not remembered. If the key store cannot be read nothing is processed and the answer is 503 idempotency_unavailable: retry with the same key.
^[A-Za-z0-9_-]{8,128}$OK
application/json- response
data*curl -X POST 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/whatsapp/threads/<threadId>/read' \ -H 'Authorization: Bearer <access_token>' \ -H 'Idempotency-Key: <unique_key>'{ "data": { "id": "string", "name": "string", "phone": "string", "preview": "string", "lastMessageAt": 0, "lastDirection": "in", "unread": 0, "needsAttention": true, "canReply": true, "replyWindowEndsAt": 0 }}