bidInbox

Requires permission biddesk:settings:manage.

The organization's bid inbox, or null when it has none yet. The address is null when this installation has no inbound email domain. Requires Bid Desk and permission to manage Bid Desk settings.

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 BidInbox {
  bidInbox {
    address
    defaultDueDays
    enabled
    version
    owner {
      id
      name
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query BidInbox {\n  bidInbox {\n    address\n    defaultDueDays\n    enabled\n    version\n    owner {\n      id\n      name\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "bidInbox": {
      "address": "string",
      "defaultDueDays": 0,
      "enabled": true,
      "version": 0,
      "owner": {
        "id": "id",
        "name": "string"
      }
    }
  }
}

bidInbox: BidInbox

Type

BidInbox object

The organization's bid inbox: one address that customers or colleagues can send requests for quotation to, the bid manager who owns bids opened from it, and how many days ahead a new draft bid is due.