dismissConnectorDeadLetter

Requires permission settings:apps:install.

Set a failed sync aside without running it again. Only an open dead letter can be dismissed.

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 DismissConnectorDeadLetter($id: ID!, $installationId: ID!) {
  dismissConnectorDeadLetter(id: $id, installationId: $installationId) {
    id
    status
    createdAt
    installationId
    reason
    resolvedAt
  }
}

cURL

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

Variables:

{
  "id": "id",
  "installationId": "id"
}

Response:

{
  "data": {
    "dismissConnectorDeadLetter": {
      "id": "id",
      "status": "DISMISSED",
      "createdAt": "2025-01-15T00:00:00Z",
      "installationId": "id",
      "reason": "string",
      "resolvedAt": "2025-01-15T00:00:00Z"
    }
  }
}

dismissConnectorDeadLetter(
  id: ID!
  installationId: ID!
): ConnectorDeadLetterView!

Arguments

dismissConnectorDeadLetter.id ● ID! non-null scalar

The dead letter.

dismissConnectorDeadLetter.installationId ● ID! non-null scalar

The installed app.

Type

ConnectorDeadLetterView object

A connector sync that failed after every retry. An admin replays or dismisses it.