markInboxThreadsRead

Mark inbox rows READ (isRead: true) or UNREAD (false), the app inbox's read/unread. Pass the ids per channel, straight from listInboxThreads: a MESSAGE row's id in textConversationIds, a CALL row's id (and every id in its groupedCallIds) in callIds, an EMAIL row's id in emailMessageIds. Omit a list for a channel you are not changing. Returns per channel what changed: smsMutation and callsMutation are row COUNTS, emailMutation lists each email now marked. An id you cannot act on (not yours, or a teammate's without VIEW_TEAM_CALLS_TEXTS or VIEW_ALL_PHONES) is skipped, never an error, so a count lower than you sent means some were skipped.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "operationId": "markInboxThreadsRead",
    "variables": {
      "isRead": true
    }
  }'

import { GoliathClient } from '@goliath-data/sdk'

const goliath = new GoliathClient({
  apiKey: process.env.GOLIATH_API_KEY!,
  baseUrl: 'https://server.goliathdata.com',
})

const result = await goliath.conversations.markInboxThreadsRead(
  {
    isRead: true
  },
  { idempotencyKey: crypto.randomUUID() },
)

const res = await fetch('https://server.goliathdata.com/api/v1/call', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.GOLIATH_API_KEY}`,
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({
    operationId: 'markInboxThreadsRead',
    variables: {
      isRead: true
    }
  }),
})
const { data, errors } = await res.json()

Variables

The example sends only what the schema requires. Some operations also need one of several optional variables (one filter or another, say); the description above says which.

isReadBoolean!required

textConversationIds[String!]

Default [].

callIds[ID!]

Default [].

emailMessageIds[ID!]

Default [].

Response

What comes back under data: a list shows as one entry, and a value as its type.

response shape

{
  "data": {
    "smsMutation": {
      "toggleBulkConversationSeen": 0
    },
    "callsMutation": {
      "toggleBulkCallSeen": 0
    },
    "emailMutation": {
      "toggleBulkEmailRead": [
        {
          "id": "<ID>",
          "isRead": true
        }
      ]
    }
  }
}

Errors

400unknown_variable

A variable the operation does not declare. A typo is refused rather than silently dropped.

401unauthorized

No bearer header, or the key is invalid or revoked.

403insufficient_scope

The key lacks the scope the operation requires.

403forbidden

A referenced record does not exist, was deleted, or is outside your organization. The gateway cannot tell those apart.

409idempotency_conflict

A request with this Idempotency-Key is still in flight.

Idempotency

Send an Idempotency-Key of 1 to 255 characters. A finished request retried with the same key replays its stored response, marked Idempotency-Replayed: true; one still in flight returns 409 idempotency_conflict. Keys expire after 24 hours. Write without fear →

curl https://server.goliathdata.com/api/v1/call \ -H "Authorization: Bearer $GOLIATH_API_KEY" \ -H "Content-Type: application/json" \ -H "Idempotency-Key: $(uuidgen)" \ -d '{ "operationId": "markInboxThreadsRead", "variables": { "isRead": true } }'

import { GoliathClient } from '@goliath-data/sdk' const goliath = new GoliathClient({ apiKey: process.env.GOLIATH_API_KEY!, baseUrl: 'https://server.goliathdata.com', }) const result = await goliath.conversations.markInboxThreadsRead( { isRead: true }, { idempotencyKey: crypto.randomUUID() }, )

const res = await fetch('https://server.goliathdata.com/api/v1/call', { method: 'POST', headers: { Authorization: `Bearer ${process.env.GOLIATH_API_KEY}`, 'Content-Type': 'application/json', 'Idempotency-Key': crypto.randomUUID(), }, body: JSON.stringify({ operationId: 'markInboxThreadsRead', variables: { isRead: true } }), }) const { data, errors } = await res.json()

Variables

Response

Errors

Idempotency

Related