updatePortalConfig

Requires at least one of the permissions settings:tenant:update or storefront:storefront:update.

Changes your organization's customer portal and buyer app settings. Only the fields given change. The change is audited. Needs storefront:storefront:update, or settings:tenant:update.

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 UpdatePortalConfig($input: UpdatePortalConfigInput!) {
  updatePortalConfig(input: $input) {
    id
    portalName
    resolvedName
    accentColor
    allowDirectOrders
    allowGuestBrowsing
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation UpdatePortalConfig($input: UpdatePortalConfigInput!) {\n  updatePortalConfig(input: $input) {\n    id\n    portalName\n    resolvedName\n    accentColor\n    allowDirectOrders\n    allowGuestBrowsing\n  }\n}",
  "variables": {
    "input": {}
  }
}
EOF

Variables:

{
  "input": {}
}

Response:

{
  "data": {
    "updatePortalConfig": {
      "id": "id",
      "portalName": "string",
      "resolvedName": "string",
      "accentColor": "string",
      "allowDirectOrders": true,
      "allowGuestBrowsing": true
    }
  }
}

updatePortalConfig(
  input: UpdatePortalConfigInput!
): PortalConfigResponse!

Arguments

updatePortalConfig.input ● UpdatePortalConfigInput! non-null input

The settings to change.

Type

PortalConfigResponse object

The portal settings, for the admin console.