grantBidDesk

Requires permission platform:access:all.

Grant Bid Desk to a tenant as the add-on or the CPQ-only plan, as a no-charge pilot or a paid monthly subscription (returns the checkout link for staff to send). Growmax platform staff only; audit-logged in the tenant.

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 GrantBidDesk($input: GrantBidDeskInput!) {
  grantBidDesk(input: $input) {
    checkoutUrl
    target {
      name
      planDisplayName
      status
      activeStaffUsers
      billing
      currentPeriodEnd
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation GrantBidDesk($input: GrantBidDeskInput!) {\n  grantBidDesk(input: $input) {\n    checkoutUrl\n    target {\n      name\n      planDisplayName\n      status\n      activeStaffUsers\n      billing\n      currentPeriodEnd\n    }\n  }\n}",
  "variables": {
    "input": {
      "billing": "MONTHLY",
      "offer": "ADDON",
      "organizationId": "id",
      "seats": 0
    }
  }
}
EOF

Variables:

{
  "input": {
    "billing": "MONTHLY",
    "offer": "ADDON",
    "organizationId": "id",
    "seats": 0
  }
}

Response:

{
  "data": {
    "grantBidDesk": {
      "checkoutUrl": "string",
      "target": {
        "name": "string",
        "planDisplayName": "string",
        "status": "string",
        "activeStaffUsers": 0,
        "billing": "MONTHLY",
        "currentPeriodEnd": "2025-01-15T00:00:00Z"
      }
    }
  }
}

grantBidDesk(
  input: GrantBidDeskInput!
): BidDeskGrantResult!

Arguments

grantBidDesk.input ● GrantBidDeskInput! non-null input

The tenant, the offer, the seats and the billing.

Type

BidDeskGrantResult object

The result of a Bid Desk grant: the tenant as it is now, and the checkout link for a paid grant.