setDeliveryPartnerEnabled

Requires permission settings:integration:update.

Turns a delivery partner on or off. Turning one on needs a verified connection and, for a provider that can only report status by webhook, a webhook that has already arrived. Needs the delivery partners plan feature and permission to update 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 SetDeliveryPartnerEnabled($enabled: Boolean!, $id: ID!) {
  setDeliveryPartnerEnabled(enabled: $enabled, id: $id) {
    id
    displayName
    available
    configuredSecretKeys
    environment
    isEnabled
    nonSecretValues {
      key
      value
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation SetDeliveryPartnerEnabled($enabled: Boolean!, $id: ID!) {\n  setDeliveryPartnerEnabled(enabled: $enabled, id: $id) {\n    id\n    displayName\n    available\n    configuredSecretKeys\n    environment\n    isEnabled\n    nonSecretValues {\n      key\n      value\n    }\n  }\n}",
  "variables": {
    "enabled": true,
    "id": "id"
  }
}
EOF

Variables:

{
  "enabled": true,
  "id": "id"
}

Response:

{
  "data": {
    "setDeliveryPartnerEnabled": {
      "id": "id",
      "displayName": "string",
      "available": true,
      "configuredSecretKeys": [
        "string"
      ],
      "environment": "LIVE",
      "isEnabled": true,
      "nonSecretValues": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
  }
}

setDeliveryPartnerEnabled(
  enabled: Boolean!
  id: ID!
): DeliveryPartnerConfigGql!

Arguments

setDeliveryPartnerEnabled.enabled ● Boolean! non-null scalar

True to turn the partner on, false to turn it off.

setDeliveryPartnerEnabled.id ● ID! non-null scalar

The ID of the delivery partner configuration.

Type

DeliveryPartnerConfigGql object

A delivery partner the organization has set up. Secret credentials are never returned.