PATCH /chat/chatrooms/{chatroom}/ambassadors/{ambassador}/archive

Headers

  • X-Popsell-Brand integer Required

    The id of the target brand

Path parameters

  • chatroom integer Required

    The chatroom id

  • ambassador integer Required

    The ambassador id

application/json

Body Required

  • archive boolean

    Archived value , (true: archived, false: unarchived)

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}/ambassadors/{ambassador}/archive
curl \
 --request PATCH 'https://domain.tld/api/v2/chat/chatrooms/{chatroom}/ambassadors/{ambassador}/archive' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-Popsell-Brand: 3" \
 --data '{"archive":true}'
Request examples
# Headers
X-Popsell-Brand: 3

# Payload
{
  "archive": true
}
Response examples (200)
{
  "message": "Chatroom archived successfully"
}