unassignBidDeskSeat

Requires permission biddesk:settings:manage.

Takes a person's Bid Desk seat away; it can be assigned again later. Refused with VERSION_CONFLICT when someone changed the seat first. 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 UnassignBidDeskSeat($expectedVersion: Int!, $userId: ID!) {
  unassignBidDeskSeat(expectedVersion: $expectedVersion, userId: $userId) {
    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 UnassignBidDeskSeat($expectedVersion: Int!, $userId: ID!) {\n  unassignBidDeskSeat(expectedVersion: $expectedVersion, userId: $userId) {\n    assigned\n    available\n    canAddSeats\n    offer\n    overAssigned\n    purchased\n    apps {\n      name\n      installationId\n    }\n  }\n}",
  "variables": {
    "expectedVersion": 0,
    "userId": "id"
  }
}
EOF

Variables:

{
  "expectedVersion": 0,
  "userId": "id"
}

Response:

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

unassignBidDeskSeat(
  expectedVersion: Int!
  userId: ID!
): BidDeskSeatOverview!

Arguments

unassignBidDeskSeat.expectedVersion ● Int! non-null scalar

The seat version the change is based on.

unassignBidDeskSeat.userId ● ID! non-null scalar

The person whose seat to unassign.

Type

BidDeskSeatOverview object

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