Partially Update a Chat

patch

https://api.arena.im/v3/sites/{siteId}/chats/{id}

Partially updates the details of an existing chat within a site using the provided patch data.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

siteId

string

required

The unique ID of the site containing the chat

string

required

The unique ID of the chat to update

Body Params

Partial chat data to update the existing chat

name

string

Name of the chat

slug

string

Slug of the chat

closed

boolean

Defaults to false

If true chat will be disabled

preModeration

boolean

Defaults to false

If true messages needs to be approved before show in chat

userUrls

boolean

Defaults to false

If true allows to users submit urls in chat

privilegeRequests

boolean

Defaults to false

If true allows users to request to be moderator

profanityFilter

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:

moderatorVisibility

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

directMessages

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:

chatColor

string

Change the chat color, using hexadecimal color

Responses

400

Invalid patch data provided in the request body

401

Unauthorized due to missing or expired authentication token

404

The specified chat or site was not found

502

Server error prevented chat update

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Successfully updated the chat