removeBidFile

Requires permission biddesk:bid:update.

Removes a file from a bid; the stored copy is kept. Refused with VERSION_CONFLICT when someone saved first. Requires Bid Desk and permission to update bids.

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 RemoveBidFile($expectedVersion: Int!, $fileId: ID!) {
  removeBidFile(expectedVersion: $expectedVersion, fileId: $fileId) {
    id
    fileName
    status
    createdAt
    bidId
    contentType
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation RemoveBidFile($expectedVersion: Int!, $fileId: ID!) {\n  removeBidFile(expectedVersion: $expectedVersion, fileId: $fileId) {\n    id\n    fileName\n    status\n    createdAt\n    bidId\n    contentType\n  }\n}",
  "variables": {
    "expectedVersion": 0,
    "fileId": "id"
  }
}
EOF

Variables:

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

Response:

{
  "data": {
    "removeBidFile": {
      "id": "id",
      "fileName": "string",
      "status": "READY",
      "createdAt": "2025-01-15T00:00:00Z",
      "bidId": "id",
      "contentType": "string"
    }
  }
}

removeBidFile(
  expectedVersion: Int!
  fileId: ID!
): BidFile!

Arguments

removeBidFile.expectedVersion ● Int! non-null scalar

The version the removal is based on.

removeBidFile.fileId ● ID! non-null scalar

The file to remove.

Type

BidFile object

A file attached to a bid, kept in private storage. Open it through bidFileDownloadUrl.