Daybook DocsDaybook Docs
Book a demo
Browse
Book a demo

Approve a portal action

POST/v1/portal-tasks/{id}/approve

Let a held portal action go through, or reject it. Only valid while the task is `approval_required`.

Used in Payer portals

Call this with AIA brief with this endpoint's request, response and auth, ready for a typed client in your language.

Path parameters

  • idstringrequired
    The portal task id.

Body

  • decisionstringrequired
    approve or reject.
  • notestring
    Kept on the task's audit trail.
Try itEdit the fields and copy the request. Nothing is sent from this page.
curl -X POST https://api.daybookhealthcare.com/v1/portal-tasks/ptask_01JBXA2W8K3N/approve \
  -H "Authorization: Bearer $DAYBOOK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "decision": "approve",
    "note": "Checked the attachment, send it."
  }'

Response

  • idstring
    Unique id, prefixed ptask_.
  • objectstring
    Always portal_task.
  • statusstring
    queued, running, approval_required, completed, failed or canceled.
  • payerstring
    Daybook payer id.
  • portalstring
    The portal used, such as availity or the payer's own site.
  • taskstring
    The task you asked for.
  • pending_actionobject
    What Daybook is about to change in the portal. Present while approval_required.
    Properties
    • summarystring
      The change, in plain words.
    • screenshot_urlstring
      Signed link to the screen as it will be submitted.
  • resultobject
    What Daybook read back. Shape depends on task. null until completed.
  • evidenceobject[]
    Signed links to the pages captured along the way.
  • metadataobject
    Your keys, echoed back.
  • created_atstring
    RFC 3339 timestamp.
curl -X POST https://api.daybookhealthcare.com/v1/portal-tasks/ptask_01JBXA2W8K3N/approve \
  -H "Authorization: Bearer $DAYBOOK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "decision": "approve",
    "note": "Checked the attachment, send it."
  }'
Response 200
{
  "id": "ptask_01JBXA2W8K3N",
  "object": "portal_task",
  "status": "running",
  "payer": "keystone",
  "portal": "availity",
  "task": "attachment_upload",
  "pending_action": null,
  "result": null,
  "evidence": [
    {
      "label": "Remittance viewer",
      "url": "https://files.daybookhealthcare.com/e/ptask_01JBXA2W8K3N/1?sig=..."
    }
  ],
  "metadata": {},
  "created_at": "2026-10-29T15:10:40Z"
}