nooks
GitHubInstall
Instance

Update instance settings

UpdateInstanceSettings replaces them. Admins only.

PUT
/api/v1/instance/settings

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X PUT "https://example.com/api/v1/instance/settings" \  -H "Content-Type: application/json" \  -d '{}'
{  "settings": {    "name": "string",    "publicSignup": true,    "publicList": {      "listUid": "string",      "showNames": true,      "showMeta": true,      "allowJoin": true,      "listName": "string"    },    "defaultLocale": "string"  }}

Get instance settings

GetInstanceSettings returns everything an Admin may change, including which List is public. Admins only: which List is published is not a fact a Visitor gets to read from the outside.

Get current member

GetCurrentMember returns whoever the session cookie belongs to.