deleteBidDeskOnboardingSource

Requires permission biddesk:settings:manage.

Removes a set-up file from the list (the stored file is kept). Refused with VERSION_CONFLICT. 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 DeleteBidDeskOnboardingSource($expectedVersion: Int!, $id: ID!) {
  deleteBidDeskOnboardingSource(expectedVersion: $expectedVersion, id: $id)
}

cURL

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

Variables:

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

Response:

{
  "data": {
    "deleteBidDeskOnboardingSource": true
  }
}

deleteBidDeskOnboardingSource(
  expectedVersion: Int!
  id: ID!
): Boolean!

Arguments

deleteBidDeskOnboardingSource.expectedVersion ● Int! non-null scalar

The version the removal is based on.

deleteBidDeskOnboardingSource.id ● ID! non-null scalar

The set-up file.

Type

Boolean scalar

The Boolean scalar type represents true or false.