Bring someone onto the team

Give a person a working identity here — who they are, what they may do, and the team they sit in.

Manage · a play in 2 steps.

The steps

1. Create their user — binds their sign-in account and sets what they may do. — createUser
2. Seat them in a team so shared work and team messages reach them. — updateTeam

The calls

Every operation this use case runs, in the order it first appears, with the request and the response its reference page shows.

createUser

createUser — mutation · Create a new staff user at your organization.

Example request

mutation ExampleCreateUser($input: NewUserInput!) {
  createUser(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    accountId
  }
}

Variables:

{
  "input": {
    "caption": "Blue jeans",
    "accountId": "01900000-0000-7000-8000-fec33a710000",
    "orgRoles": [
      {
        "org": "01900000-0000-7000-8000-9c1df0590000",
        "roles": [
          "01900000-0000-7000-8000-98bc5cde0000"
        ]
      }
    ]
  }
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "createUser": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "US-EXMP-0000-000F",
      "type": "User",
      "caption": "Blue jeans",
      "status": "active",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "accountId": "01900000-0000-7000-8000-fec33a710000"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

updateTeam

updateTeam — mutation · Edit a team — a working group of staff — change its details.

Example request

mutation ExampleUpdateTeam($id: ID!, $revision: ID!, $input: EditTeamInput!) {
  updateTeam(id: $id, revision: $revision, input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    memberUserIds
    leadUserId
  }
}

Variables:

{
  "id": "01900000-0000-7000-8000-37386ae00000",
  "revision": "01900000-0000-7000-8000-b7960e180000",
  "input": {
    "caption": "Blue jeans"
  }
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "updateTeam": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "TM-EXMP-0000-000F",
      "type": "Team",
      "caption": "Blue jeans",
      "status": "active",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "memberUserIds": [
        "01900000-0000-7000-8000-77bba28a0000"
      ],
      "leadUserId": "01900000-0000-7000-8000-3e7bb9b10000"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}