startBidThread

Requires permission biddesk:bid:read.

Starts a thread about one item of a bid with its first message, visible to the bid's members only. Refused when that kind of item cannot be discussed yet or the item is not in the bid. Only the bid's members can use its room. 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

mutation StartBidThread($input: StartBidThreadInput!) {
  startBidThread(input: $input) {
    id
    status
    createdAt
    anchorId
    anchorType
    bidId
    rootMessage {
      id
      senderName
      createdAt
      content
      deleted
      parentId
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation StartBidThread($input: StartBidThreadInput!) {\n  startBidThread(input: $input) {\n    id\n    status\n    createdAt\n    anchorId\n    anchorType\n    bidId\n    rootMessage {\n      id\n      senderName\n      createdAt\n      content\n      deleted\n      parentId\n    }\n  }\n}",
  "variables": {
    "input": {
      "anchorId": "id",
      "anchorType": "APPROVAL_STAGE",
      "bidId": "id",
      "content": "string"
    }
  }
}
EOF

Variables:

{
  "input": {
    "anchorId": "id",
    "anchorType": "APPROVAL_STAGE",
    "bidId": "id",
    "content": "string"
  }
}

Response:

{
  "data": {
    "startBidThread": {
      "id": "id",
      "status": "OPEN",
      "createdAt": "2025-01-15T00:00:00Z",
      "anchorId": "id",
      "anchorType": "APPROVAL_STAGE",
      "bidId": "id",
      "rootMessage": {
        "id": "id",
        "senderName": "string",
        "createdAt": "2025-01-15T00:00:00Z",
        "content": "string",
        "deleted": true,
        "parentId": "id"
      }
    }
  }
}

startBidThread(
  input: StartBidThreadInput!
): BidThread!

Arguments

startBidThread.input ● StartBidThreadInput! non-null input

The bid, the item and the first message.

Type

BidThread object

A conversation in a bid's room about one item of the bid.