startBidDeskPilotBid

Requires permission biddesk:settings:manage.

Starts a pilot bid from a past bid in the imported history: an ordinary bid titled "Pilot:...", for the same customer when it is one, due in seven days. Replacing an existing pilot needs its version (VERSION_CONFLICT otherwise). Also needs permission to create bids. Requires Bid Desk and permission to manage its 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 StartBidDeskPilotBid($input: StartBidDeskPilotBidInput!) {
  startBidDeskPilotBid(input: $input) {
    bidNumber
    bidId
    bidStatus
    comparable
    costNow
    costThen
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation StartBidDeskPilotBid($input: StartBidDeskPilotBidInput!) {\n  startBidDeskPilotBid(input: $input) {\n    bidNumber\n    bidId\n    bidStatus\n    comparable\n    costNow\n    costThen\n  }\n}",
  "variables": {
    "input": {
      "historicalBidId": "id"
    }
  }
}
EOF

Variables:

{
  "input": {
    "historicalBidId": "id"
  }
}

Response:

{
  "data": {
    "startBidDeskPilotBid": {
      "bidNumber": "string",
      "bidId": "id",
      "bidStatus": "CANCELLED",
      "comparable": true,
      "costNow": "string",
      "costThen": "string"
    }
  }
}

startBidDeskPilotBid(
  input: StartBidDeskPilotBidInput!
): BidDeskPilotComparison!

Arguments

startBidDeskPilotBid.input ● StartBidDeskPilotBidInput! non-null input

The past bid to replay, and the version of any pilot being replaced.

Type

BidDeskPilotComparison object

The pilot bid beside the past bid it replays: what was quoted and what it cost then, and what the pilot's latest cost sheet says now. Amounts are decimal strings in their own currency and are never converted.