bidFileDownloadUrl

Requires permission biddesk:bid:read.

A link that opens one uploaded bid file for five minutes. Refused with BID_FILE_STORAGE_UNAVAILABLE when storage cannot be reached. Requires Bid Desk and permission to read 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

query BidFileDownloadUrl($fileId: ID!) {
  bidFileDownloadUrl(fileId: $fileId)
}

cURL

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

Variables:

{
  "fileId": "id"
}

Response:

{
  "data": {
    "bidFileDownloadUrl": "string"
  }
}

bidFileDownloadUrl(
  fileId: ID!
): String!

Arguments

bidFileDownloadUrl.fileId ● ID! non-null scalar

The file to open.

Type

String scalar

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.