Invites

Invite group to topic

POST

https://discourse.example.com/t/{id}/invite-group.json

curl -X POST 'https://discourse.example.com/t/string/invite-group.json' \
  -H 'Api-Key: string' \
  -H 'Api-Username: string' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "group": "string",
  "should_notify": true
}'

const body = `{
  "group": "string",
  "should_notify": true
}`;

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

const data = await response.text();

import requests

body = '''{
  "group": "string",
  "should_notify": true
}'''

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

Request Body

{
  "group": "string",
  "should_notify": true
}

200

{
  "group": {
    "id": 0,
    "name": "string"
  }
}

Body

application/json

groupstring

The name of the group to invite

should_notifyboolean

Whether to notify the group, it defaults to true

Parameters

Api-Keystringrequiredheader

Api-Usernamestringrequiredheader

idstringrequiredpath

Response

200OKobject

invites to a PM

Response fields application/json

groupobject

Show child attributes

idinteger

namestring

Docs by Sourcey