revokeBidDeskGrant

Requires permission platform:access:all.

Revoke a tenant's Bid Desk grant: an add-on, or a CPQ-only tenant with no live paid plan subscription. Bid Desk turns off; the plan and the data are kept. 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 RevokeBidDeskGrant($organizationId: ID!) {
  revokeBidDeskGrant(organizationId: $organizationId) {
    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 RevokeBidDeskGrant($organizationId: ID!) {\n  revokeBidDeskGrant(organizationId: $organizationId) {\n    name\n    planDisplayName\n    status\n    activeStaffUsers\n    billing\n    currentPeriodEnd\n  }\n}",
  "variables": {
    "organizationId": "id"
  }
}
EOF

Variables:

{
  "organizationId": "id"
}

Response:

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

revokeBidDeskGrant(
  organizationId: ID!
): BidDeskGrantTarget!

Arguments

revokeBidDeskGrant.organizationId ● ID! non-null scalar

The tenant organization's id.

Type

BidDeskGrantTarget object

One tenant as Growmax platform staff see it when granting Bid Desk: who it is and on what terms it has Bid Desk.