setBidDeskPurchasedSeats

Requires permission biddesk:settings:manage.

Changes how many Bid Desk seats the organization pays for, through its subscription: added seats are prorated on the next invoice, removed seats are not refunded. Refused with SEATS_BELOW_ASSIGNED when more people hold seats than requested, and with SEATS_SET_BY_GROWMAX for a pilot without a paid subscription. Requires Bid Desk and 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 SetBidDeskPurchasedSeats($seats: Int!) {
  setBidDeskPurchasedSeats(seats: $seats) {
    assigned
    available
    canAddSeats
    offer
    overAssigned
    purchased
    apps {
      name
      installationId
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation SetBidDeskPurchasedSeats($seats: Int!) {\n  setBidDeskPurchasedSeats(seats: $seats) {\n    assigned\n    available\n    canAddSeats\n    offer\n    overAssigned\n    purchased\n    apps {\n      name\n      installationId\n    }\n  }\n}",
  "variables": {
    "seats": 0
  }
}
EOF

Variables:

{
  "seats": 0
}

Response:

{
  "data": {
    "setBidDeskPurchasedSeats": {
      "assigned": 0,
      "available": 0,
      "canAddSeats": true,
      "offer": "string",
      "overAssigned": 0,
      "purchased": 0,
      "apps": [
        {
          "name": "string",
          "installationId": "id"
        }
      ]
    }
  }
}

setBidDeskPurchasedSeats(
  seats: Int!
): BidDeskSeatOverview!

Arguments

setBidDeskPurchasedSeats.seats ● Int! non-null scalar

The seats to pay for, 10 to 1000.

Type

BidDeskSeatOverview object

The organization's Bid Desk seats: purchased and assigned counts, who holds one and who can be given one.