discoursejs/docs/sdk/models/operations/createinviterequestbody.md

CreateInviteRequestBody

Example Usage

import { CreateInviteRequestBody } from "@lukehagar/discoursejs/sdk/models/operations";

let value: CreateInviteRequestBody = {
  email: "not-a-user-yet@example.com",
  groupIds: "42,43",
  groupNames: "foo,bar",
  maxRedemptionsAllowed: 5,
};

Fields

Field	Type	Required	Description	Example
customMessage	string	➖	optional, for email invites
email	string	➖	required for email invites only	not-a-user-yet@example.com
expiresAt	string	➖	optional, if not supplied, the invite_expiry_days site setting is used
groupIds	string	➖	Optional, either this or group_names. Comma separated list for multiple ids.	42,43
groupNames	string	➖	Optional, either this or group_ids. Comma separated list for multiple names.	foo,bar
maxRedemptionsAllowed	number	➖	optional, for link invites	5
skipEmail	boolean	➖	N/A
topicId	number	➖	N/A