Shipeasy
APIOperations

Withdraw a question

Withdraw one open question you asked — it no longer needs an answer (you found it out yourself, or the item moved on). The question moves to cancelled and…

Withdraw one open question you asked — it no longer needs an answer (you found it out yourself, or the item moved on). The question moves to cancelled and leaves the detail panel. Withdrawing the last open question of a run delivers nothing.

Use case

You asked, then answered it yourself from the code — take it off the person's plate.

POST
/api/admin/ops/{handle}/questions/{questionId}/cancel

Authorization

bearerSdkKey
AuthorizationBearer <token>

Pass an admin SDK key as Authorization: Bearer sdk_admin_…. Mint via POST /api/admin/keys with type: "admin".

In: header

Path Parameters

handle*string

Per-project item number (e.g. 7) or the full ops item id, or a trail handle (e.g. T-12) for a question on a trail.

Length1 <= length <= 128
questionId*string

The question id (from ask or list).

Length1 <= length <= 128

Header Parameters

X-Project-Id?string

Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://shipeasy.ai/api/admin/ops/string/questions/string/cancel"
{
  "id": "string",
  "feedbackId": "string",
  "trailId": "string",
  "header": "string",
  "question": "string",
  "options": [
    {
      "label": "string",
      "description": "string"
    }
  ],
  "multiSelect": true,
  "status": "open",
  "answer": {
    "selected": [
      "string"
    ],
    "other": "string"
  },
  "answeredBy": "string",
  "answeredAt": "string",
  "agent": "jarvis",
  "askedBy": "string",
  "runId": "string",
  "delivery": "resume",
  "deliveredAt": "string",
  "deliveryError": "string",
  "createdAt": "string",
  "updatedAt": "string"
}
{
  "error": "Malformed request (bad JSON, missing project scope).",
  "code": "BAD_REQUEST"
}
{
  "error": "Missing or invalid admin SDK key.",
  "code": "UNAUTHORIZED"
}

{
  "error": "Key is valid but not allowed to act on this project.",
  "code": "FORBIDDEN"
}

{
  "error": "The resource does not exist or is not visible to the caller.",
  "code": "NOT_FOUND"
}

{
  "error": "A resource with this name already exists in the project.",
  "code": "ALREADY_EXISTS"
}

Was this page helpful?