Skip to content

A platform for community discussion. Free, open, simple.

1.1 KB
Raw Blame
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "email": {
      "type": "string",
      "example": "[email protected]",
      "description": "required for email invites only"
    },
    "skip_email": {
      "type": "boolean",
      "default": false
    },
    "custom_message": {
      "type": "string",
      "description": "optional, for email invites"
    },
    "max_redemptions_allowed": {
      "type": "integer",
      "example": 5,
      "default": 1,
      "description": "optional, for link invites"
    },
    "topic_id": {
      "type": "integer"
    },
    "group_ids": {
      "type": "string",
      "description": "Optional, either this or `group_names`. Comma separated list for multiple ids.",
      "example": "42,43"
    },
    "group_names": {
      "type": "string",
      "description": "Optional, either this or `group_ids`. Comma separated list for multiple names.",
      "example": "foo,bar"
    },
    "expires_at": {
      "type": "string",
      "description": "optional, if not supplied, the invite_expiry_days site setting is used"
    }
  }
}