deleteBidConfiguration

Requires permission biddesk:bid:update.

Deletes a draft configuration. Refused with CONFIGURATION_FROZEN once frozen (a snapshot is never deleted), VERSION_CONFLICT when someone changed it first. Requires Bid Desk and permission to edit 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

mutation DeleteBidConfiguration($input: BidConfigurationVersionInput!) {
  deleteBidConfiguration(input: $input)
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation DeleteBidConfiguration($input: BidConfigurationVersionInput!) {\n  deleteBidConfiguration(input: $input)\n}",
  "variables": {
    "input": {
      "expectedVersion": 0,
      "id": "id"
    }
  }
}
EOF

Variables:

{
  "input": {
    "expectedVersion": 0,
    "id": "id"
  }
}

Response:

{
  "data": {
    "deleteBidConfiguration": true
  }
}

deleteBidConfiguration(
  input: BidConfigurationVersionInput!
): Boolean!

Arguments

deleteBidConfiguration.input ● BidConfigurationVersionInput! non-null input

The configuration and its version.

Type

Boolean scalar

The Boolean scalar type represents true or false.