createInvitation

Invite a user to an organization

createInvitation(
  input: CreateInvitationInput
): CreateInvitationPayload!

Example

Query

mutation ($input: CreateInvitationInput) {
  createInvitation(input: $input) {
    invitations {
      acceptedAt
      createdAt
      emailAddress
      expiresAt
      id
      isCancelable
      isResendable
      status
    }
  }
}

Variables

{
  "input": {
    "emailAddresses": [
      "emailAddresses"
    ],
    "grantedPermissions": {
      "applicationRoles": [
        {
          "appId": 42,
          "roleId": "admin"
        }
      ],
      "organizationRoleId": "admin"
    },
    "organizationId": 42
  }
}

Response

{
  "data": {
    "createInvitation": {
      "invitations": [
        {
          "acceptedAt": "acceptedAt",
          "createdAt": "createdAt",
          "emailAddress": "emailAddress",
          "expiresAt": "expiresAt",
          "id": 42,
          "isCancelable": true,
          "isResendable": true,
          "status": "status"
        }
      ]
    }
  }
}

Arguments

createInvitation.input ● CreateInvitationInput input common

The organization, email addresses, and permissions for the invitation.

Type

CreateInvitationPayload object common

The result of creating invitations.