setBidStatus

Requires permission biddesk:bid:update.

Moves a bid to another status: open to submitted, no bid or cancelled; submitted to won, lost, cancelled or back to open. Lost, no bid and cancelled need a reason (BID_REASON_REQUIRED). 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 SetBidStatus($input: SetBidStatusInput!) {
  setBidStatus(input: $input) {
    id
    bidNumber
    title
    status
    createdAt
    closedAt
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation SetBidStatus($input: SetBidStatusInput!) {\n  setBidStatus(input: $input) {\n    id\n    bidNumber\n    title\n    status\n    createdAt\n    closedAt\n  }\n}",
  "variables": {
    "input": {
      "expectedVersion": 0,
      "id": "id",
      "status": "CANCELLED"
    }
  }
}
EOF

Variables:

{
  "input": {
    "expectedVersion": 0,
    "id": "id",
    "status": "CANCELLED"
  }
}

Response:

{
  "data": {
    "setBidStatus": {
      "id": "id",
      "bidNumber": "string",
      "title": "string",
      "status": "CANCELLED",
      "createdAt": "2025-01-15T00:00:00Z",
      "closedAt": "2025-01-15T00:00:00Z"
    }
  }
}

setBidStatus(
  input: SetBidStatusInput!
): Bid!

Arguments

setBidStatus.input ● SetBidStatusInput! non-null input

The bid, its version, the new status and the reason.

Type

Bid object

One bid: its number, title, customer, owner, due date, status, stage, confidentiality and estimated value in the organization's base currency.