grantTeamMemberCapability

Turn ONE permission on for a teammate, a switch in Manage permissions on their row. Off for a member unless granted: VIEW_ALL_CONTACTS, VIEW_ALL_DEALS, VIEW_ALL_PHONES (call and text from any team number), CONTRACTS_VIEW, CONTRACTS_MANAGE. On unless an admin turned them off (granting one gives it back): CAN_SKIPTRACE, CAN_EXPORT, CAN_WORKFLOW (run workflows), VIEW_TEAM_DIRECTORY (see who else is on the team), VIEW_TEAM_CALENDARS (see teammates' calendars on the Team calendar), VIEW_TEAM_CALLS_TEXTS (read teammates' calls and texts in the Team inbox; email only from mailboxes their owner shares), and the app sections CAN_USE_AUTOMATIONS (and workflow operations), CAN_USE_FILES, CAN_USE_MARKETPLACE, VIEW_ORGANIZATION_SETTINGS, CAN_USE_API_KEYS. Their role does not change: this is the answer to "give X access to Y" for a Member, never a promotion to Admin. userId comes from listTeamMembers. An Admin already holds every permission, so it changes nothing for one. Takes effect within a minute. 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": "grantTeamMemberCapability",
    "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.grantTeamMemberCapability>[0]

const result = await goliath.team.grantTeamMemberCapability(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: 'grantTeamMemberCapability',
    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": {
      "grantTeamMemberCapability": {
        "id": "<ID>"
      }
    }
  }
}

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": "grantTeamMemberCapability", "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.grantTeamMemberCapability>[0] const result = await goliath.team.grantTeamMemberCapability(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: 'grantTeamMemberCapability', variables: { userId: '<userId>', capability: 'VIEW_ALL_CONTACTS' } }), }) const { data, errors } = await res.json()

Variables

Response

Errors

Idempotency

Related