APG PayAPG Paydocs

Operations

Update export jobs

PATCH/export-jobs

Cancel every queued or running export job of one tenant, or put back in the queue every job that failed on the platform's side since a time. Answers the jobs changed and those left as they were.

2 actionsExptjobsUpdateCancelTenantExptjobsUpdateRequeueFailed

Permissions

Required permission
queues:update

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

Request body

This body is a typed union. Pick a variant to see its fields and a matching example.

Discriminated by type
type = "ExptjobsUpdateCancelTenant"
tenantstringrequired

The tenant, by contextual id (ent_, mktp_, mcht_), or platform.

curl -X PATCH https://api.tst.au.apgpay.dev/export-jobs \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "ExptjobsUpdateCancelTenant",
  "tenant": "string"
}'

Responses

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

Discriminated by type
type = "ExptjobActedAttributes"

The exports it changed.

skippedarray of ExptjobId

The exports it left, because their tenant already ran as many as it may.

Example expt_9f2Kd8QpLzXw

Example
{
  "type": "ExptjobActedAttributes",
  "acted": [
    {
      "type": "ExptjobViewAttributes",
      "exportJobId": "expt_9f2Kd8QpLzXw",
      "tenant": "string",
      "owner": "string",
      "source": "string",
      "sourceKind": "List",
      "summary": "string",
      "state": "Queued",
      "rowsWritten": 1250,
      "failureCode": "Refused",
      "failure": "string",
      "createdAt": "2026-08-19T04:21:07Z",
      "startedAt": "2026-08-19T04:21:07Z",
      "finishedAt": "2026-08-19T04:21:07Z"
    }
  ],
  "skipped": [
    "expt_9f2Kd8QpLzXw"
  ]
}

Error responses