Flag a chatroom

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

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

flag integer | null

Flag's value , (1: todo, 2: done)

Values are 1 or 2.

Responses

200 application/json

Return success message
Hide response attribute Show response attribute object
- message string | null
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}/flag

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

Request examples

# Headers
X-Popsell-Brand: 3

# Payload
{
  "flag": 1
}

Response examples (200)

{
  "message": "Chatroom flagged successfully"
}

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"
    ]
  }
}