Fuselage
Dismiss a banner
Dismisses a banner
URL
Requires Auth
HTTP Method
api/v1/banners.dismiss
YES
POST

Headers

Argument
Example
Required
Description
X-User-Id
myuser-name
Required
Your username hash (returned after you log in through the API)
X-Auth-Token
myauth-token
Required
Your token (returned after you log in through the API)

Example Call

curl --location --request POST 'http://localhost:3000/api/v1/banners.dismiss\
--header 'X-Auth-Token: myauth-token' \
--header 'X-User-Id: myuser-name'
-d "bannerId=ByehQjC44FwMeiLbX"

Result

Success

{
"success": true
}

Errors

The following errors can occur upon the endpoint.
  • Authorization: Requires an authentication token for the request to be made.
  • Missing Key: Requires bannerId for the request to be made.
Authorization
Missing key
{
"status": "error",
"message": "You must be logged in to do this."
}
{
"success": false,
"error": "Match error: Missing key 'bannerId'"
}
Export as PDF
Copy link
Edit on GitHub
On this page
Headers
Example Call
Result
Success
Errors