Skip to content
vocapable.Docs

Propose a correction to an approved answer (or a new answer)

POST
/v1/workspace/knowledge/proposals
curl --request POST \
  --url https://api.vocapable.com/v1/workspace/knowledge/proposals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "pack_id": "example", "expected_version": 1, "source_index": 1, "label": "example", "proposed_value": "example", "reason": "example" }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
WorkspaceKnowledgeProposal
object
pack_id
required
Pack Id
string
>= 1 characters <= 64 characters
expected_version
required
Expected Version
integer
>= 1
source_index
Any of:
integer
label
Any of:
string
>= 1 characters <= 200 characters
proposed_value
required
Proposed Value
string
>= 1 characters <= 1200 characters
reason
Any of:
string
<= 1000 characters
Examplegenerated
{
  "pack_id": "example",
  "expected_version": 1,
  "source_index": 1,
  "label": "example",
  "proposed_value": "example",
  "reason": "example"
}

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
WorkspaceKnowledgeReview
object
id
required
Id
string
pack_id
required
Pack Id
string
pack_name
required
Pack Name
string
kind
required
Kind
string
Allowed values: stale source_changed conflict proposed_update
field
required
Any of:
string
current_value
required
Any of:
string
proposed_value
required
Any of:
string
source_url
required
Any of:
string
evidence
required
Any of:
string
status
required
Status
string
Allowed values: open published dismissed rolled_back
base_version
required
Any of:
integer
source_index
required
Any of:
integer
approval_id
required
Any of:
string
approval_status
required
Any of:
string
created_by
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
resolved_by
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
resolved_at
required
Any of:
string format: date-time
published_version
required
Any of:
integer
stale
required
Stale
boolean
revision
required
Revision
integer
created_at
required
Created At
string format: date-time
Example
{
  "kind": "stale",
  "status": "open"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}