PATCH /chat/chatrooms/{chatroom}/purge

Path parameters

  • chatroom integer Required

    The chatroom id

application/json

Body

  • id_ambassador integer Required

Responses

  • 200 application/json

    Return success message

    Hide response attribute Show response attribute object
    • message string
  • 403

    Forbidden - You don't have permission to access this route

  • 404

    Not found - The chatroom does not exist

PATCH /chat/chatrooms/{chatroom}/purge
curl \
 --request PATCH 'https://domain.tld/api/v2/chat/chatrooms/{chatroom}/purge' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"id_ambassador":5}'
Request examples
{
  "id_ambassador": 5
}
Response examples (200)
{
  "message": "Chatroom purged successfully"
}