replayDocumentDelivery

Requires at least one of the permissions settings:documents:update or settings:email:update.

Operator-triggered redo of a dead-lettered (FAILED) document delivery.

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 ReplayDocumentDelivery($id: String!) {
  replayDocumentDelivery(id: $id) {
    id
    documentNumber
    status
    createdAt
    attempts
    contentHash
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation ReplayDocumentDelivery($id: String!) {\n  replayDocumentDelivery(id: $id) {\n    id\n    documentNumber\n    status\n    createdAt\n    attempts\n    contentHash\n  }\n}",
  "variables": {
    "id": "string"
  }
}
EOF

Variables:

{
  "id": "string"
}

Response:

{
  "data": {
    "replayDocumentDelivery": {
      "id": "string",
      "documentNumber": "string",
      "status": "DELIVERED",
      "createdAt": "2025-01-15T00:00:00Z",
      "attempts": 0,
      "contentHash": "string"
    }
  }
}

replayDocumentDelivery(
  id: String!
): OutboxDeliveryRow!

Arguments

replayDocumentDelivery.id ● String! non-null scalar

The ID of the document delivery.

Type

OutboxDeliveryRow object

One outbound document email and where its delivery stands.