assignBidDeskSeats

Requires permission biddesk:settings:manage.

Gives each listed person a Bid Desk seat, or none of them: refused with SEAT_NOT_ELIGIBLE for anyone who is not active staff, and with SEATS_EXHAUSTED when the seats would exceed those purchased. People who already hold a seat are skipped. 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 AssignBidDeskSeats($userIds: [ID!]!) {
  assignBidDeskSeats(userIds: $userIds) {
    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 AssignBidDeskSeats($userIds: [ID!]!) {\n  assignBidDeskSeats(userIds: $userIds) {\n    assigned\n    available\n    canAddSeats\n    offer\n    overAssigned\n    purchased\n    apps {\n      name\n      installationId\n    }\n  }\n}",
  "variables": {
    "userIds": [
      "id"
    ]
  }
}
EOF

Variables:

{
  "userIds": [
    "id"
  ]
}

Response:

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

assignBidDeskSeats(
  userIds: [ID!]!
): BidDeskSeatOverview!

Arguments

assignBidDeskSeats.userIds ● [ID!]! non-null scalar

The people to seat, 1 to 100.

Type

BidDeskSeatOverview object

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