leaveBidRoom

Requires permission biddesk:bid:read.

Says the signed-in member closed the bid's room. Returns true when they had it open. Requires Bid Desk, permission to read bids and membership of the bid.

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 LeaveBidRoom($bidId: ID!) {
  leaveBidRoom(bidId: $bidId)
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation LeaveBidRoom($bidId: ID!) {\n  leaveBidRoom(bidId: $bidId)\n}",
  "variables": {
    "bidId": "id"
  }
}
EOF

Variables:

{
  "bidId": "id"
}

Response:

{
  "data": {
    "leaveBidRoom": true
  }
}

leaveBidRoom(
  bidId: ID!
): Boolean!

Arguments

leaveBidRoom.bidId ● ID! non-null scalar

The bid.

Type

Boolean scalar

The Boolean scalar type represents true or false.