createAccountInvitation(input: AccountInvitationCreateInput!): CreatedAccountInvitation!

Requires account.invitations.manage.

Arguments

Argument	Type	Required
`input`	`AccountInvitationCreateInput!`	Yes

Input fields

input

AccountInvitationCreateInput

Field	Type	Required	Description
`accountId`	`ID!`	Yes
`email`	`String!`	Yes	Invitation recipient email. Only one pending invitation is allowed per email; another creation returns 409 until it is revoked or expires. Creation does not send email or reserve a seat; tier and seat capacity are checked when a new member accepts.
`role`	`String`	No	Invited administrator or member role. Defaults to administrator for existing clients.

Response

Returns CreatedAccountInvitation!. Open the type for its fields and nested types.

Field	Type
`id`	`ID!`
`accountId`	`ID!`
`email`	`String!`
`role`	`String!`
`status`	`String!`
`expiresAt`	`String!`
`invitedByUserId`	`ID`
`acceptedByUserId`	`ID`

All fields of CreatedAccountInvitation.

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql

mutation CreateAccountInvitation($input: AccountInvitationCreateInput!) {
  createAccountInvitation(input: $input) {
    id
    status
    createdAt
    acceptedByUserId
    accountId
  }
}

json

{
  "input": {
    "accountId": "00000000-0000-4000-8000-000000000001",
    "email": "example"
  }
}