A type that describes the input for the AddChannelMember mutation.

link GraphQL Schema definition

  • input AddChannelMembersInput {
  • # The user ids to be added to the channel as contributors, meaning they have
  • # editing access.
  • contributorUserIds: [String]
  • # The user ids to be added to the channel as members, meaning they have only read
  • # access.
  • memberUserIds: [String]
  • # The user to be assigned as the owner of the channel. There can only ever be one
  • # channel owner, the current channel owner will become a contributor.
  • ownerUserId: String
  • # The ID of the Channel to which the User will be added.
  • channelId: String!
  • # The User ID of the User adding the Member or Contributor.
  • # The User must be part of the plan and either be the Channel Owner or an Editor
  • # to add Member(s) or Contributor(s).
  • # If the 'actorUserId' is not provided an email notification will not be sent
  • # regardless of the 'skipNotificationEmail' setting.
  • actorUserId: String!
  • # Instruction verbiage that is appended to the new member email. <= 500 character
  • # limit. Does not apply to adding a new channel owner.
  • instructions: String
  • # A boolean field that toggles email notifications. A 'true' value prevents email
  • # notifications from being sent to added members. The default is 'false'.
  • skipNotificationEmail: Boolean
  • }