requestBidDeskOnboardingUpload

Requires permission biddesk:settings:manage.

Starts a private upload of one set-up file (.xlsx,.xls,.csv or.pdf; Word documents are refused with a hint to save them as PDF) and returns a short-lived link to PUT it to. Confirm it after the upload. 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 RequestBidDeskOnboardingUpload($fileName: String!) {
  requestBidDeskOnboardingUpload(fileName: $fileName) {
    sourceId
    uploadUrl
    version
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation RequestBidDeskOnboardingUpload($fileName: String!) {\n  requestBidDeskOnboardingUpload(fileName: $fileName) {\n    sourceId\n    uploadUrl\n    version\n  }\n}",
  "variables": {
    "fileName": "string"
  }
}
EOF

Variables:

{
  "fileName": "string"
}

Response:

{
  "data": {
    "requestBidDeskOnboardingUpload": {
      "sourceId": "id",
      "uploadUrl": "string",
      "version": 0
    }
  }
}

requestBidDeskOnboardingUpload(
  fileName: String!
): BidDeskOnboardingUpload!

Arguments

requestBidDeskOnboardingUpload.fileName ● String! non-null scalar

The file's name, with its extension.

Type

BidDeskOnboardingUpload object

A private upload link for one set-up file. PUT the file to uploadUrl, then confirm it.