deleteDeliveryPartnerConfig

Requires permission settings:integration:delete.

Deletes a delivery partner configuration. The partner is switched off and its webhook URL stops working for good, and the same provider can be set up again later. Needs the delivery partners plan feature and permission to delete integrations.

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 DeleteDeliveryPartnerConfig($id: ID!) {
  deleteDeliveryPartnerConfig(id: $id)
}

cURL

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

Variables:

{
  "id": "id"
}

Response:

{
  "data": {
    "deleteDeliveryPartnerConfig": true
  }
}

deleteDeliveryPartnerConfig(
  id: ID!
): Boolean!

Arguments

deleteDeliveryPartnerConfig.id ● ID! non-null scalar

The ID of the delivery partner configuration.

Type

Boolean scalar

The Boolean scalar type represents true or false.