Skip to content
Vocapable Developers

Save a team decision against the current qualification answers

POST
/v1/workflow-outcomes/{action_id}/fit-reviews
curl --request POST \
  --url https://api.vocapable.com/v1/workflow-outcomes/example/fit-reviews \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --data '{ "decision": "good_fit", "reason": "example", "expected_revision": 1 }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
action_id
required
Action Id
string

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
required
string
<= 255 characters

Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries Idempotent-Replay: true. A UUID is the documented shape. Required on this endpoint: a retry without one would dial a human twice or spend money twice.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
QualificationReviewRequest
object
decision
required
Decision
string
Allowed values: good_fit not_a_fit needs_follow_up
reason
required
Reason
string
>= 1 characters <= 2000 characters
expected_revision
required
Expected Revision
integer

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
QualificationReview
object
id
required
Id
string
action_id
required
Action Id
string
revision
required
Revision
integer
>= 1
decision
required
Decision
string
Allowed values: good_fit not_a_fit needs_follow_up
reason
required
Reason
string
reviewer_ref
required
Reviewer Ref
string
created_at
required
Created At
string format: date-time
Example
{
  "decision": "good_fit"
}

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": {}
    }
  ]
}