Invites

Create an invite

POST

https://discourse.example.com/invites.json

Create an invite

curl -X POST 'https://discourse.example.com/invites.json' \
  -H 'Api-Key: string' \
  -H 'Api-Username: string' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "email": "not-a-user-yet@example.com",
  "skip_email": false,
  "custom_message": "string",
  "max_redemptions_allowed": 5,
  "topic_id": 0,
  "group_ids": "42,43",
  "group_names": "foo,bar",
  "expires_at": "string"
}'

const body = `{
  "email": "not-a-user-yet@example.com",
  "skip_email": false,
  "custom_message": "string",
  "max_redemptions_allowed": 5,
  "topic_id": 0,
  "group_ids": "42,43",
  "group_names": "foo,bar",
  "expires_at": "string"
}`;

const response = await fetch('https://discourse.example.com/invites.json', {
  method: 'POST',
  headers: {
    'Api-Key': 'string',
    'Api-Username': 'string',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "email": "not-a-user-yet@example.com",
  "skip_email": false,
  "custom_message": "string",
  "max_redemptions_allowed": 5,
  "topic_id": 0,
  "group_ids": "42,43",
  "group_names": "foo,bar",
  "expires_at": "string"
}'''

response = requests.post(
    'https://discourse.example.com/invites.json',
    data=body.encode('utf-8'),
    headers={
        'Api-Key': 'string',
        'Api-Username': 'string',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "email": "not-a-user-yet@example.com",
  "skip_email": false,
  "custom_message": "string",
  "max_redemptions_allowed": 5,
  "topic_id": 0,
  "group_ids": "42,43",
  "group_names": "foo,bar",
  "expires_at": "string"
}

200

{
  "id": 42,
  "invite_key": "string",
  "link": "http://example.com/invites/9045fd767efe201ca60c6658bcf14158",
  "description": "string",
  "email": "not-a-user-yet@example.com",
  "domain": "string",
  "emailed": false,
  "can_delete_invite": true,
  "custom_message": "Hello world!",
  "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,
  "grants_admin": false,
  "grants_moderator": false,
  "topics": [],
  "groups": []
}

Body

application/json

emailstring

required for email invites only

Example

not-a-user-yet@example.com

skip_emailbooleanfalse

custom_messagestring

optional, for email invites

max_redemptions_allowedinteger1

optional, for link invites

Example

topic_idinteger

group_idsstring

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

Example

42,43

group_namesstring

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

Example

foo,bar

expires_atstring

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

Parameters

Api-Keystringrequiredheader

Api-Usernamestringrequiredheader

Response

200OKobject

success response

Response fields application/json

idintegerrequired

Example

invite_keystringrequired

linkstringrequired

Example

http://example.com/invites/9045fd767efe201ca60c6658bcf14158

descriptionstring | nullrequired

emailstringrequired

Example

not-a-user-yet@example.com

domainstring | nullrequired

emailedbooleanrequired

Example

false

can_delete_invitebooleanrequired

custom_messagestring | nullrequired

Example

Hello world!

created_atstringrequired

Example

2021-01-01T12:00:00.000Z

updated_atstringrequired

Example

2021-01-01T12:00:00.000Z

expires_atstringrequired

Example

2021-02-01T12:00:00.000Z

expiredbooleanrequired

Example

false

grants_adminbooleanrequired

Example

false

grants_moderatorbooleanrequired

Example

false

topicsArray<object>required

Example

[]

groupsArray<object>required

Example

[]

Docs by Sourcey