LIlivelike

Update a Chat Room

patch/{id}

Request

  • Base URL
    https://cf-blast.livelikecdn.com/api/v1/chat-rooms
  • URL
    https://cf-blast.livelikecdn.com/api/v1/chat-rooms/{id}
  • Auth
    none required

Path parameters

idstring required

Chat Room ID

Request body

titlestring

Set an optional title for the Chat Room

content_filter'none' | 'filtered' | 'producer' | 'ai'

To manage the type of messages allowed in a chat room, we provide three levels of content filtering. Each level determines how messages are moderated and who is allowed to post. 1. none: No content filtering, all users can post freely. 2.filtered: Profanity is automatically filtered. 3. producer: Only producers can post, others can view messages only. 4. ai: message recognized by an AI model as objectionable, will be filtered.

sticker_pack_idsstring[]

Sticker Pack IDs

reaction_pack_idsstring[]

Reaction Pack IDs

visibility'everyone' | 'members'

Who is allowed to see and join the chat room. Can be everyone or members.

sponsor_idsstring[]

Links the sponsors with this chat room. Note that only valid sponsor IDs will be linked to a chatroom.

chat_message_throttle_secondsnumber

Set chat room messages throttling

profile_groupsstring[]

Array of user groups you want to link to the chat room

Response

200

idstring
urlstring
client_idstring
titleunknown
created_atstring
content_filterstring
visibilitystring
upload_urlstring
memberships_urlstring
sticker_packs_urlstring
reaction_packs_urlstring
sponsors_urlstring
chat_message_throttle_secondsnumber

Example response

{
  "id": "5052ea2f-0cb4-4fb6-bec8-fe275826b266",
  "url": "https://cf-blast.livelikecdn.com/api/v1/chat-rooms/5052ea2f-0cb4-4fb6-bec8-fe275826b266/",
  "client_id": "8PqSNDgIVHnXuJuGte1HdvOjOqhCFE1ZCR3qhqaS",
  "created_at": "2020-04-28T13:35:52.973396Z",
  "content_filter": "none",
  "visibility": "everyone",
  "channels": {
    "chat": {
      "pubnub": "chatroom.5052ea2f-0cb4-4fb6-bec8-fe275826b266"
    },
    "reactions": {
      "pubnub": "chatroomreactions.5052ea2f-0cb4-4fb6-bec8-fe275826b266"
    }
  },
  "upload_url": "https://cf-blast.livelikecdn.com/api/v1/chat-rooms/5052ea2f-0cb4-4fb6-bec8-fe275826b266/upload/",
  "memberships_url": "https://cf-blast.livelikecdn.com/api/v1/chat-rooms/5052ea2f-0cb4-4fb6-bec8-fe275826b266/memberships/",
  "sticker_packs_url": "https://cf-blast.livelikecdn.com/api/v1/sticker-packs/?chat_room_id=5052ea2f-0cb4-4fb6-bec8-fe275826b266",
  "reaction_packs_url": "https://cf-blast.livelikecdn.com/api/v1/reaction-packs/?chat_room_id=5052ea2f-0cb4-4fb6-bec8-fe275826b266",
  "sponsors_url": "https://cf-blast-storage.livelikecdn.com/sticker-packs/ff8d89f6-3d7b-48de-87a8-f3588674eef8/sponsors.json"
}

Changes

No recorded changes to this operation across all 1 revision of this API.