bidDeskStatus

Requires an authenticated session.

Whether Bid Desk is included in the organization's plan, whether the organization has switched it on, and so whether it is on. Answers while Bid Desk is switched off. Refused when the plan does not include Bid Desk.

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

query BidDeskStatus {
  bidDeskStatus {
    enabled
    entitled
    on
  }
}

cURL

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

Response:

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

bidDeskStatus: 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.