leaveStorefrontEditor

Requires permission storefront:storefront:read.

A closing storefront editor window says goodbye, so the others stop listing it at once instead of after 90 seconds. Best effort: true when it was listed.

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 LeaveStorefrontEditor($sessionId: String!) {
  leaveStorefrontEditor(sessionId: $sessionId)
}

cURL

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

Variables:

{
  "sessionId": "string"
}

Response:

{
  "data": {
    "leaveStorefrontEditor": true
  }
}

leaveStorefrontEditor(
  sessionId: String!
): Boolean!

Arguments

leaveStorefrontEditor.sessionId ● String! non-null scalar

The closing window's own id, as its heartbeats sent it. Only the signed-in person's own window is removed.

Type

Boolean scalar

The Boolean scalar type represents true or false.