GoliathDevelopersGet an API key
Reference/Teamgenerated from the gateway manifest

removeTeamMember

Remove a teammate from the team, the team page's Remove from team.

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

Remove a teammate from the team, the team page's Remove from team. It is a SUSPENSION, not a delete: they lose access at once and stop using a seat, but stay on listTeamMembers as SUSPENDED and restoreTeamMember brings them back. On the way out their open tasks go to YOU (the key owner), their contacts' point-person seats are released (a contact left with no agent gets you), and they are taken out of the workflow steps and lead-routing forms that named them. Restoring does NOT hand any of that back; the person approves it on a card. Optional reason is kept on the member. You cannot remove yourself. Organization admins only. The result reports what the handover did: handover (NOT_NEEDED | REASSIGNED | REMOVED | FAILED), reassignedTaskCount, releasedContactSeatCount, handedOverContactCount, and openWorkTruncated / openWorkFailed when some work is still theirs; tell the user those.

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": "removeTeamMember",
    "variables": {
      "userId": "<userId>"
    }
  }'
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.team.removeTeamMember(
  {
    userId: '<userId>'
  },
  { 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: 'removeTeamMember',
    variables: {
      userId: '<userId>'
    }
  }),
})
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
reasonString

Response

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

response shape
{
  "data": {
    "organizationMutation": {
      "suspendOrganizationMemberWithImpact": {
        "userId": "<ID>",
        "handover": "NOT_NEEDED",
        "handoverSourceCount": 0,
        "intactSourceCount": 0,
        "retainedPartnerGrantCount": 0,
        "reassignedTaskCount": 0,
        "releasedContactSeatCount": 0,
        "handedOverContactCount": 0,
        "openWorkTruncated": true,
        "openWorkFailed": 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 →

READlistTeammatesREADlistTeamMembersREADgetTeammatesByIdsREADcountOutboundTextsREADgetTeamCallStatsREADgetMemberActivity