disableBidDesk

Requires permission biddesk:settings:manage.

Switches Bid Desk off for the organization and returns its status. Bid Desk screens and jobs stop, and every Bid Desk record is kept for when it is switched back on. Does nothing when it is already off. Refused when the plan does not include Bid Desk. Requires permission to manage Bid Desk settings.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation DisableBidDesk {
  disableBidDesk {
    enabled
    entitled
    on
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation DisableBidDesk {\n  disableBidDesk {\n    enabled\n    entitled\n    on\n  }\n}"
}
EOF

Response:

{
  "data": {
    "disableBidDesk": {
      "enabled": true,
      "entitled": true,
      "on": true
    }
  }
}

disableBidDesk: BidDeskStatus!

Type

BidDeskStatus object

Whether Bid Desk is on for the organization. It is on only when the organization's plan includes Bid Desk and the organization has switched it on.