confirmBidDeskOnboardingUpload

Requires permission biddesk:settings:manage.

Confirms an uploaded set-up file: it must be stored privately under the organisation and be at most 25 MB (a larger file is marked FAILED). Refused with ONBOARDING_FILE_MISSING, ONBOARDING_FILE_TOO_LARGE, ONBOARDING_SOURCE_STATE and VERSION_CONFLICT. 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 ConfirmBidDeskOnboardingUpload($expectedVersion: Int!, $sourceId: ID!) {
  confirmBidDeskOnboardingUpload(
    expectedVersion: $expectedVersion
    sourceId: $sourceId
  ) {
    id
    failureCode
    fileName
    status
    createdAt
    contentType
  }
}

cURL

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

Variables:

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

Response:

{
  "data": {
    "confirmBidDeskOnboardingUpload": {
      "id": "id",
      "failureCode": "string",
      "fileName": "string",
      "status": "FAILED",
      "createdAt": "2025-01-15T00:00:00Z",
      "contentType": "string"
    }
  }
}

confirmBidDeskOnboardingUpload(
  expectedVersion: Int!
  sourceId: ID!
): BidDeskOnboardingSource!

Arguments

confirmBidDeskOnboardingUpload.expectedVersion ● Int! non-null scalar

The version the confirmation is based on.

confirmBidDeskOnboardingUpload.sourceId ● ID! non-null scalar

The set-up file.

Type

BidDeskOnboardingSource object

One of the organisation's own set-up files (a BOM, a price list, past quotes, terms), stored privately for Bid Desk onboarding. The file itself is never exposed here.