GoliathDevelopersGet an API key
Reference/Teamgenerated from the gateway manifest

revokeTeamMemberCapability

Turn ONE permission off for a teammate, the same switch and the same capabilities as grantTeamMemberCapability, which turns it back on.

POST/api/v1/callADMINidempotent · 24 hruns as the key's owner
View as Markdown

Turn ONE permission off for a teammate, the same switch and the same capabilities as grantTeamMemberCapability, which turns it back on. Their role does not change. An Admin holds every permission whatever is stored, so read getTeamMemberCapabilities first and never offer one for an Admin (their role changes first). Organization admins only; the person approves it on a card naming the teammate and the permission.

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": "revokeTeamMemberCapability",
    "variables": {
      "userId": "<userId>",
      "capability": "VIEW_ALL_CONTACTS"
    }
  }'
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 = {
  userId: '<userId>',
  capability: 'VIEW_ALL_CONTACTS'
} as Parameters<typeof goliath.team.revokeTeamMemberCapability>[0]

const result = await goliath.team.revokeTeamMemberCapability(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: 'revokeTeamMemberCapability',
    variables: {
      userId: '<userId>',
      capability: 'VIEW_ALL_CONTACTS'
    }
  }),
})
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.

userIdID!required
capabilityOrganizationCapability!required
VIEW_ALL_CONTACTSVIEW_ALL_PIPELINE_ITEMSVIEW_ALL_DEALSVIEW_ALL_PHONESCONTRACTS_VIEWCONTRACTS_MANAGECAN_SKIPTRACECAN_EXPORTCAN_WORKFLOWVIEW_TEAM_DIRECTORYCAN_USE_AUTOMATIONSCAN_USE_FILESCAN_USE_MARKETPLACEVIEW_ORGANIZATION_SETTINGSCAN_USE_API_KEYSCAN_USE_COMPUTERCAN_MANAGE_SPENDINGVIEW_TEAM_CALENDARSVIEW_TEAM_CALLS_TEXTS

Response

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

response shape
{
  "data": {
    "teamMutation": {
      "revokeTeamMemberCapability": {
        "id": "<ID>"
      }
    }
  }
}

Errors

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 →