createBid

Requires permission biddesk:bid:create.

Opens a bid: it takes the next number from the Bids series, the organization's base currency, and the caller as owner unless one is given. Refused with BID_CUSTOMER_NOT_A_CUSTOMER, BID_DUE_IN_PAST, BID_BAD_VALUE or BID_NO_BASE_CURRENCY. Requires Bid Desk and permission to create 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 CreateBid($input: CreateBidInput!) {
  createBid(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 CreateBid($input: CreateBidInput!) {\n  createBid(input: $input) {\n    id\n    bidNumber\n    title\n    status\n    createdAt\n    closedAt\n  }\n}",
  "variables": {
    "input": {
      "dueAt": "2025-01-15T00:00:00Z",
      "title": "string"
    }
  }
}
EOF

Variables:

{
  "input": {
    "dueAt": "2025-01-15T00:00:00Z",
    "title": "string"
  }
}

Response:

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

createBid(
  input: CreateBidInput!
): Bid!

Arguments

createBid.input ● CreateBidInput! non-null input

The new bid.

Type

Bid object

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