Skip to content
vocapable.Docs

Prepare a signature request for the current version (opens an approval)

POST
/v1/workspace/quotes/{quote_id}/signature-requests
curl --request POST \
  --url https://api.vocapable.com/v1/workspace/quotes/example/signature-requests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "installation_id": "example", "template_id": "example", "recipient_role": "example", "reviewed": true }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
quote_id
required
Quote Id
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
WorkspaceSignatureRequestCreate
object
installation_id
required
Installation Id
string
template_id
required
Template Id
string
>= 1 characters <= 200 characters
recipient_role
required
Recipient Role
string
>= 1 characters <= 100 characters
reviewed
required
Reviewed
boolean
Examplegenerated
{
  "installation_id": "example",
  "template_id": "example",
  "recipient_role": "example",
  "reviewed": true
}

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
WorkspaceSignatureRequest
object
id
required
Id
string
quote_id
required
Quote Id
string
quote_version_id
required
Quote Version Id
string
quote_version_number
required
Any of:
integer
installation_id
required
Installation Id
string
provider
required
Provider
string
Allowed values: pandadoc docusign
template_id
required
Template Id
string
template_label
required
Any of:
string
recipient_name
required
Recipient Name
string
recipient_email
required
Recipient Email
string
recipient_role
required
Recipient Role
string
status
required
Status
string
Allowed values: awaiting_approval approved sending sent viewed completed declined voided expired failed superseded cancelled
delivery
required
WorkspaceBusinessDelivery

Where the provider operation behind a record stands (Connection activity has the full history). failed/held records are retried by reconciling first.

object
state
required
State
string
Allowed values: not_started pending succeeded failed uncertain held
error_class
required
Any of:
string
can_retry
required
Can Retry
boolean
approval
required
Any of:
WorkspaceApproval

One request for review, pinned to the exact payload reviewed (its digest).

object
id
required
Id
string
action_type
required
Action Type
string
subject_type
required
Subject Type
string
subject_id
required
Subject Id
string
digest
required
Digest
string
summary
required
Summary
object
key
additional properties
any
requested_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
reviewer
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
status
required
Status
string
Allowed values: awaiting_review changes_requested approved declined expired stale executing confirmed failed
decided_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
decided_at
required
Any of:
string format: date-time
reason
required
Any of:
string
expires_at
required
Expires At
string format: date-time
revision
required
Revision
integer
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
external_document_id
required
Any of:
string
provider_status
required
Any of:
string
acceptance_id
required
Any of:
string
sent_at
required
Any of:
string format: date-time
completed_at
required
Any of:
string format: date-time
declined_reason
required
Any of:
string
next_refresh_at
required
Any of:
string format: date-time
revision
required
Revision
integer
created_at
required
Created At
string format: date-time
Example
{
  "provider": "pandadoc",
  "status": "awaiting_approval",
  "delivery": {
    "state": "not_started"
  },
  "approval": {
    "status": "awaiting_review"
  }
}

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