Accept a quarantined email

curl --request POST \
  --url https://api.hq.zone/v1/api/email/quarantine/{id}/accept \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bind_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

{
  "ok": true,
  "handling_state": "<string>",
  "note": "<string>"
}

Admin

Accept a quarantined email

Accepts a pending quarantined inbound email, marking it accepted, and returns an ok flag with an optional explanatory note. Admin only. Optionally binds the sender to a named workspace user (required to clear an unknown-sender quarantine) so their future mail routes; when the destination is now reachable the message is re-delivered so an agent acts on it immediately, otherwise it routes on the sender’s next mail. Returns 404 if no pending quarantine with that id exists.

POST

api

quarantine

{id}

Accept a quarantined email

curl --request POST \
  --url https://api.hq.zone/v1/api/email/quarantine/{id}/accept \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bind_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

{
  "ok": true,
  "handling_state": "<string>",
  "note": "<string>"
}

Authorizations

Authorization

string

header

required

Personal Access Token. Send as Authorization: Bearer hq_pat_....

Path Parameters

string<uuid>

required

Quarantine id

Body

application/json

bind_user_id

string<uuid> | null

Bind the quarantined sender to this HQ user so their mail routes from now on. Required to clear an unknown_sender quarantine.

Response

Quarantine accepted (sender optionally bound + re-delivered)

boolean

required

handling_state

string | null

note

string | null

Get quarantined email content Reject a quarantined email

⌘I