Users

Creates a user

POST

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

Creates a user

curl -X POST 'https://discourse.example.com/users.json' \
  -H 'Api-Key: string' \
  -H 'Api-Username: string' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "name": "string",
  "email": "string",
  "password": "string",
  "username": "string",
  "active": true,
  "approved": true,
  "user_fields": {
    "1": true
  },
  "external_ids": {}
}'

const body = `{
  "name": "string",
  "email": "string",
  "password": "string",
  "username": "string",
  "active": true,
  "approved": true,
  "user_fields": {
    "1": true
  },
  "external_ids": {}
}`;

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

const data = await response.text();

import requests

body = '''{
  "name": "string",
  "email": "string",
  "password": "string",
  "username": "string",
  "active": true,
  "approved": true,
  "user_fields": {
    "1": true
  },
  "external_ids": {}
}'''

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

Request Body

{
  "name": "string",
  "email": "string",
  "password": "string",
  "username": "string",
  "active": true,
  "approved": true,
  "user_fields": {
    "1": true
  },
  "external_ids": {}
}

200

{
  "success": true,
  "active": true,
  "message": "string",
  "user_id": 0
}

Body

application/json

namestringrequired

emailstringrequired

passwordstringrequired

usernamestringrequired

activeboolean

This param requires an admin api key in the request header or it will be ignored

approvedboolean

user_fieldsobject

Show child attributes

1boolean

external_idsobject

Parameters

Api-Keystringrequiredheader

Api-Usernamestringrequiredheader

Response

200OKany

user created

Response fields application/json

successbooleanrequired

activebooleanrequired

messagestringrequired

user_idinteger

Docs by Sourcey