APG PayAPG Paydocs

Operations

Update queue dead letter

PATCH/queues/{queueId}/dead-letters/{deadLetterId}

Act on one dead letter. QueueDlqReplay publishes the message again, unchanged. A deadLetter that does not belong to this queue is a 404, not a redirect.

Permissions

Required permission
queues:update

Requires the `update` action on `queues` for the supplied runtime context

Path parameters

queueIdstring
required
deadLetterIdstring
required

Request body

This body is a tagged shape: type is always "QueueDlqReplay". Send it; more variants can be added, and a caller that switches on it keeps working when they are.

Discriminated by type
type = "QueueDlqReplay"

This variant has no additional fields.

curl -X PATCH https://api.tst.au.apgpay.dev/queues/{queueId}/dead-letters/{deadLetterId} \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "QueueDlqReplay"
}'

Responses

The response is a tagged shape: type is always "QueuedlqUpdateRspAttributes". Switch on it; subtypes can be added, and a client that already reads it will not break.

Discriminated by type
type = "QueuedlqUpdateRspAttributes"

The resource as it stands after the change.

Example
{
  "type": "QueuedlqUpdateRspAttributes",
  "updated": {
    "type": "QueueDeadLetterAttributes",
    "queueDeadLetterId": "string",
    "queue": "string",
    "consumer": "string",
    "diedAt": "2026-08-19T04:21:07Z",
    "reason": "Requested by the customer.",
    "eventId": 1250,
    "publishedAt": "2026-08-19T04:21:07Z",
    "message": {
      "type": "QueueMessageAttributes",
      "eventType": "string",
      "data": "string",
      "extra1": "string",
      "extra2": "string",
      "extra3": "string",
      "extra4": "string"
    }
  }
}

Error responses