Block a chatroom for an ambassador

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

Bearer token

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

is_blocked boolean Required

Block value , (true: blocked, false: unblocked)

Responses

200 application/json

Return success message
Hide response attribute Show response attribute object
- message string
401 application/json

Unauthorized.
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
422 application/json

Unprocessable Content
Hide response attributes Show response attributes object
- message string
  
  Error message.
- errors object
  
  Hide errors attributes Show errors attributes object
  
  field array[string]
  
  Error message details.
  
  * array[string] Additional properties
  
  Error message details.

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

curl \
 -X PATCH https://domain.tld/api/v2/chat/chatrooms/{chatroom}/ambassadors/{ambassador}/block \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -H "X-Popsell-Brand: 3" \
 -d '{"is_blocked":true}'

Request examples

# Headers
X-Popsell-Brand: 3

# Payload
{
  "is_blocked": true
}

Response examples (200)

{
  "message": "chatroom 12 blocked successfully for ambassador 3"
}

Response examples (401)

{
  "message": "Unauthorized."
}

Response examples (422)

{
  "message": "field is required! (and 3 more error)",
  "errors": {
    "field": [
      "Error message details here"
    ],
    "additionalProperty1": [
      "Error message details here"
    ],
    "additionalProperty2": [
      "Error message details here"
    ]
  }
}