TEteaflask
authed

Dismiss a doc request

Close a doc request without publishing: every unpublished draft of its doc, members' edits included, is discarded — the doc and its history remain — and the request becomes dismissed. Works on a ready_for_review, failed or unfunded request; refused while it is queued or working.

post/api/v1/doc-requests/{request_id}/dismiss

Request

  • Base URL
    https://api.teaflask.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.teaflask.com/api/v1/doc-requests/{request_id}/dismiss
  • Auth
    none declared

Path parameters

request_idstring uuid required

The doc request's id, as list_doc_requests returns it.

Response

Successful Response

idstring uuid required

The doc request's id.

organization_idstring uuid required

The organization that owns the request.

promptstring required

What the doc was requested to cover.

status'queued' | 'working' | 'ready_for_review' | 'approved' | 'dismissed' | 'failed' | 'unfunded' required
errorstring nullable required

Why the request failed, in a sentence; null unless it failed.

requested_by_user_idstring uuid required

The member who asked.

requested_bystring nullable required

That member's name, or their email when they have no name.

doc_idstring uuid nullable required

The doc the draft was written into; null until a draft exists.

created_atstring date-time required

When the request was made.

updated_atstring date-time required

When the request last changed.

Changes

No recorded changes to this operation across all 1 revision of this API.