Hide a banner - Bavlio

POST

/workspace/membership/hidden-banners

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

bannerstringrequired

The banner to hide for good.

Required string length: 1 - 200

Response

application/json

Success

workspaceobjectrequired

roleenum<string>required

The account's role here: owner (one per workspace, the only one who can transfer ownership), admin (can change the profile, setup, team and billing) or member (works in the workspace without those rights).

Available options: owner, admin, member

defaultbooleanrequired

True when calls without a bavlio-workspace header act in this workspace.

email_noticesobjectrequired

Which email notices the member receives, true for on: reply_needs_answer when a lead's reply needs an answer, meeting_booked and meeting_canceled when a meeting is booked or canceled, trial_ending a few days before the workspace's trial ends (sent to the owner and admins only). New members start with only trial_ending on.

hidden_bannersstring[]required

The banners this member hid for good in this workspace.

Hide a banner

curl --request POST \
  --url https://api.bavlio.com/workspace/membership/hidden-banners \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "banner": "<string>"
}
'

curl --request POST \  --url https://api.bavlio.com/workspace/membership/hidden-banners \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{  "banner": "<string>"}'

{
  "workspace": {
    "id": "<string>",
    "org_id": "<string>",
    "name": "<string>",
    "sells": "<string>",
    "problems": [
      "<string>"
    ],
    "customers": [
      "<string>"
    ],
    "domain": "<string>",
    "booking_link": "<string>",
    "attribution": "chatgpt",
    "timezone": "<string>",
    "week_start": "monday",
    "working_days": [
      "sunday"
    ],
    "working_hours": {
      "start": 123,
      "end": 123
    },
    "onboarded_at": "<string>",
    "created_at": "<string>"
  },
  "role": "owner",
  "default": true,
  "email_notices": {
    "reply_needs_answer": true,
    "meeting_booked": true,
    "meeting_canceled": true,
    "trial_ending": true
  },
  "hidden_banners": [
    "<string>"
  ]
}

{  "workspace": {    "id": "<string>",    "org_id": "<string>",    "name": "<string>",    "sells": "<string>",    "problems": [      "<string>"    ],    "customers": [      "<string>"    ],    "domain": "<string>",    "booking_link": "<string>",    "attribution": "chatgpt",    "timezone": "<string>",    "week_start": "monday",    "working_days": [      "sunday"    ],    "working_hours": {      "start": 123,      "end": 123    },    "onboarded_at": "<string>",    "created_at": "<string>"  },  "role": "owner",  "default": true,  "email_notices": {    "reply_needs_answer": true,    "meeting_booked": true,    "meeting_canceled": true,    "trial_ending": true  },  "hidden_banners": [    "<string>"  ]}