bidProactivePolicy

Requires permission biddesk:bid:read.

The organization's current Bid Desk proactive policy (null until one is saved, and until then nothing is chased) and the product defaults. 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 BidProactivePolicy {
  bidProactivePolicy {
    defaults
    current {
      id
      enteredByName
      createdAt
      appliesToOpen
      body
      enteredBy
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query BidProactivePolicy {\n  bidProactivePolicy {\n    defaults\n    current {\n      id\n      enteredByName\n      createdAt\n      appliesToOpen\n      body\n      enteredBy\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "bidProactivePolicy": {
      "defaults": {},
      "current": {
        "id": "id",
        "enteredByName": "string",
        "createdAt": "2025-01-15T00:00:00Z",
        "appliesToOpen": true,
        "body": {},
        "enteredBy": "id"
      }
    }
  }
}

bidProactivePolicy: BidProactivePolicySettings!

Type

BidProactivePolicySettings object

The organization's current Bid Desk proactive policy and the product defaults a settings screen starts from.