API Reference

Create a Chat for a Site

post
https://api.arena.im/v3/sites//chats

Creates a new chat associated with the specified site using the provided chat data.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique ID of the site to associate the new chat with

Body Params

Chat data required to create a new chat

string

Name of the chat

string

Slug of the chat

boolean
required
Defaults to false

If true chat will be disabled

boolean
Defaults to false

If true messages needs to be approved before show in chat

boolean
Defaults to false

If true allows to users submit urls in chat

boolean
Defaults to false

If true allows users to request to be moderator

string
enum
Defaults to none

Define the filter applied to messages

  • block: block all
  • none: no filter applied
  • replace: replace the message
  • false: disable the filter
  • true: enable the filter
  • blocked: block all
Allowed:
string
enum
Defaults to ALL

Show the who are the moderators to users

  • ALL: show moderators in chat and channels
  • CHANNEL: show moderators only in channels
  • FLAGGED: do not show who are the moderators
Allowed:
signUpSettings
object

Settings for sign up

string
enum
Defaults to all

Change behavior to send direct messages for other users.

  • all: all users can send messages to others users
  • moderators: only moderators can send messages to others users
Allowed:
string

Change the chat color, using hexadecimal color

Responses

400

Invalid chat data provided in the request body

401

Unauthorized due to missing or expired authentication token

404

The specified site was not found

502

Server error prevented chat creation

Updated 10 months ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 months ago