bidChaseDrafts

Requires permission biddesk:bid:read.

Every outside reminder one bid is due to send now, as drafts. 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 BidChaseDrafts($bidId: ID!) {
  bidChaseDrafts(bidId: $bidId) {
    audience
    bidId
    bodyText
    dueAt
    mode
    slotKey
    recipients {
      address
      deliverable
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query BidChaseDrafts($bidId: ID!) {\n  bidChaseDrafts(bidId: $bidId) {\n    audience\n    bidId\n    bodyText\n    dueAt\n    mode\n    slotKey\n    recipients {\n      address\n      deliverable\n    }\n  }\n}",
  "variables": {
    "bidId": "id"
  }
}
EOF

Variables:

{
  "bidId": "id"
}

Response:

{
  "data": {
    "bidChaseDrafts": [
      {
        "audience": "CUSTOMER",
        "bidId": "id",
        "bodyText": "string",
        "dueAt": "2025-01-15T00:00:00Z",
        "mode": "AUTO",
        "slotKey": "id",
        "recipients": [
          {
            "address": "string",
            "deliverable": true
          }
        ]
      }
    ]
  }
}

bidChaseDrafts(
  bidId: ID!
): [BidChaseDraft!]!

Arguments

bidChaseDrafts.bidId ● ID! non-null scalar

The bid.

Type

BidChaseDraft object

An outside reminder ready to send: from a fixed template, with the organization's own paragraph if it wrote one. Carries no amount.