Dismiss a Banner
- Print
- DarkLight
- PDF
Dismiss a Banner
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/api/v1/banners.dismiss
Header parameters
X-Auth-Token
stringRequired
The authorization token of the user.
Example9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq
X-User-Id
stringRequired
The user ID of the user.
ExampleaobEdbYhXfu5hkeqG
Body parameters
Success
{
"bannerId": "ByehQjC44FwMeiLbX"
}object
bannerId
string Required
The banner ID that you want to dismiss.
ExampleByehQjC44FwMeiLbX
Responses
200
OK
Success Example
{
"success": true
}object
success
boolean
400
Bad Request
Invalid Params
{
"success": false,
"error": "must have required property 'bannerId' [invalid-params]",
"errorType": "invalid-params"
}object
success
boolean
error
string
errorType
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
Was this article helpful?