Invites

Create multiple invites

POST

https://discourse.example.com/invites/create-multiple.json

curl -X POST 'https://discourse.example.com/invites/create-multiple.json' \
  -H 'Api-Key: string' \
  -H 'Api-Username: string' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "email": [
    "not-a-user-yet-1@example.com",
    "not-a-user-yet-2@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-1@example.com",
    "not-a-user-yet-2@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/create-multiple.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-1@example.com",
    "not-a-user-yet-2@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/create-multiple.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-1@example.com",
    "not-a-user-yet-2@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

{
  "num_successfully_created_invitations": 42,
  "num_failed_invitations": 42,
  "failed_invitations": [],
  "successful_invitations": [
    {
      "id": 42,
      "link": "http://example.com/invites/9045fd767efe201ca60c6658bcf14158",
      "email": "not-a-user-yet-1@example.com",
      "emailed": true,
      "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
    },
    {
      "id": 42,
      "link": "http://example.com/invites/c6658bcf141589045fd767efe201ca60",
      "email": "not-a-user-yet-2@example.com",
      "emailed": true,
      "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
    }
  ]
}

Body

application/json

emailstring

pass 1 email per invite to be generated. other properties will be shared by each invite.

Example

[
  "not-a-user-yet-1@example.com",
  "not-a-user-yet-2@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

num_successfully_created_invitationsinteger

Example

num_failed_invitationsinteger

Example

failed_invitationsArray<any>

Example

[]

successful_invitationsarray

Example

[
  {
    "id": 42,
    "link": "http://example.com/invites/9045fd767efe201ca60c6658bcf14158",
    "email": "not-a-user-yet-1@example.com",
    "emailed": true,
    "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
  },
  {
    "id": 42,
    "link": "http://example.com/invites/c6658bcf141589045fd767efe201ca60",
    "email": "not-a-user-yet-2@example.com",
    "emailed": true,
    "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
  }
]

Docs by Sourcey