Create an invite

POST 
/invites.json

Create an invite

Request

Header Parameters

Api-Key stringrequired
Api-Username stringrequired

application/json

Body

email stringrequired

required for email invites only

skip_email booleanrequired

Default value: false

custom_message stringrequired

optional, for email invites

max_redemptions_allowed integerrequired

Default value: 1

optional, for link invites

topic_id integerrequired
group_ids stringrequired

Optional, either this or group_names. Comma separated list for multiple ids.

group_names stringrequired

Optional, either this or group_ids. Comma separated list for multiple names.

expires_at stringrequired

optional, if not supplied, the invite_expiry_days site setting is used

Responses

200

success response

application/json

Schema

Schema

id integerrequired
link stringrequired
email stringrequired
emailed booleanrequired
custom_message stringnullrequired
topics undefined[]required
groups undefined[]required
created_at stringrequired
updated_at stringrequired
expires_at stringrequired
expired booleanrequired

Example (from schema)

{
  "id": 42,
  "link": "http://example.com/invites/9045fd767efe201ca60c6658bcf14158",
  "email": "not-a-user-yet@example.com",
  "emailed": false,
  "custom_message": "Hello world!",
  "topics": [],
  "groups": [],
  "created_at": "2021-01-01T12:00:00.000Z",
  "updated_at": "2021-01-01T12:00:00.000Z",
  "expires_at": "2021-02-01T12:00:00.000Z",
  "expired": false
}

Loading...