GoliathDevelopersGet an API key
Reference/Teamgenerated from the gateway manifest

changeTeamMemberRole

Change a teammate's ROLE, the team page's Change Role.

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

Change a teammate's ROLE, the team page's Change Role: ADMIN (every permission, and the role every ADMIN-scoped operation needs; moving to it drops the member's permission settings) or MEMBER (what they may do is their permissions, set by an admin in the app). userId comes from listTeamMembers, which also shows the current role. It takes effect at once. Refused when it would leave the organization with no active admin (the only admin demoting themself). Organization admins only. Returns the member with their new organizationRole.

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": "changeTeamMemberRole",
    "variables": {
      "userId": "<userId>",
      "role": "ADMIN"
    }
  }'
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>',
  role: 'ADMIN'
} as Parameters<typeof goliath.team.changeTeamMemberRole>[0]

const result = await goliath.team.changeTeamMemberRole(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: 'changeTeamMemberRole',
    variables: {
      userId: '<userId>',
      role: 'ADMIN'
    }
  }),
})
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
roleOrganizationToUserMappingType!required
ADMINMEMBER

Response

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

response shape
{
  "data": {
    "organizationMutation": {
      "changeUserRole": {
        "id": "<ID>",
        "organizationRole": "ADMIN"
      }
    }
  }
}

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