dismissInboxItem

Dismiss one inbox row, the app inbox's Dismiss: it is hidden from the inbox of the line or mailbox it belongs to, and listInboxThreads no longer returns it. itemId is the row's id and itemType its type (MESSAGE | CALL | EMAIL); a CALL dismisses that number's whole day of calls, an EMAIL its whole thread. There is NO undo and no view of dismissed rows, in the app or here, so confirm with the user first; to clear an unread badge use markInboxThreadsRead instead. Organization admins only, like the app. A row outside your organization is refused (FORBIDDEN).

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": "dismissInboxItem",
    "variables": {
      "itemId": "<itemId>",
      "itemType": "CALL"
    }
  }'

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

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

// Enum values as strings: the SDK's enum types aren't exported yet, so assert to the method's variables type.
const variables = {
  itemId: '<itemId>',
  itemType: 'CALL'
} as Parameters<typeof goliath.conversations.dismissInboxItem>[0]

const result = await goliath.conversations.dismissInboxItem(variables, { 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: 'dismissInboxItem',
    variables: {
      itemId: '<itemId>',
      itemType: 'CALL'
    }
  }),
})
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.

itemIdID!required

itemTypeInboxItemType!required

CALLMESSAGEEMAIL

Response

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

response shape

{
  "data": {
    "inboxMutation": {
      "dismissInboxItem": 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": "dismissInboxItem", "variables": { "itemId": "<itemId>", "itemType": "CALL" } }'

import { GoliathClient } from '@goliath-data/sdk' const goliath = new GoliathClient({ apiKey: process.env.GOLIATH_API_KEY!, baseUrl: 'https://server.goliathdata.com', }) // Enum values as strings: the SDK's enum types aren't exported yet, so assert to the method's variables type. const variables = { itemId: '<itemId>', itemType: 'CALL' } as Parameters<typeof goliath.conversations.dismissInboxItem>[0] const result = await goliath.conversations.dismissInboxItem(variables, { 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: 'dismissInboxItem', variables: { itemId: '<itemId>', itemType: 'CALL' } }), }) const { data, errors } = await res.json()

Variables

Response

Errors

Idempotency

Related