rotateBidInboxAddress

Requires permission biddesk:settings:manage.

Gives the bid inbox a new address. The old address stops working at once. Refused with VERSION_CONFLICT when someone saved first. 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

mutation RotateBidInboxAddress($expectedVersion: Int!) {
  rotateBidInboxAddress(expectedVersion: $expectedVersion) {
    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": "mutation RotateBidInboxAddress($expectedVersion: Int!) {\n  rotateBidInboxAddress(expectedVersion: $expectedVersion) {\n    address\n    defaultDueDays\n    enabled\n    version\n    owner {\n      id\n      name\n    }\n  }\n}",
  "variables": {
    "expectedVersion": 0
  }
}
EOF

Variables:

{
  "expectedVersion": 0
}

Response:

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

rotateBidInboxAddress(
  expectedVersion: Int!
): BidInbox!

Arguments

rotateBidInboxAddress.expectedVersion ● Int! non-null scalar

The version you loaded.

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.