Skip to content
vocapable.Docs

Create the customer's link to the current version

POST
/v1/workspace/quotes/{quote_id}/share
curl --request POST \
  --url https://api.vocapable.com/v1/workspace/quotes/example/share \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "expected_revision": 1, "expires_in_days": 14 }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
quote_id
required
Quote Id
string

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
Any of:
string

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.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
WorkspaceQuoteShareCreate
object
expected_revision
required
Expected Revision
integer
>= 1
expires_in_days
Expires In Days
integer
default: 14 >= 1 <= 60

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
WorkspaceShareLinkCreated

The customer link, shown ONCE: only its hash is stored.

object
link
required
WorkspaceShareLink
object
id
required
Id
string
purpose
required
Purpose
string
Allowed values: quote booking payment
quote_version_id
required
Quote Version Id
string
version_number
required
Any of:
integer
state
required
State
string
Allowed values: live expired revoked superseded voided
expires_at
required
Expires At
string format: date-time
revoked_at
required
Any of:
string format: date-time
last_viewed_at
required
Any of:
string format: date-time
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
created_at
required
Created At
string format: date-time
url
required
Url
string
quote
required
WorkspaceQuote
object
id
required
Id
string
organization_id
required
Organization Id
string
organization_name
required
Organization Name
string
opportunity_id
required
Any of:
string
recipient_contact_id
required
Any of:
string
recipient_name
required
Any of:
string
status
required
Status
string
Allowed values: draft pending_approval approved shared changes_requested accepted signing voided expired
current_version
required
Any of:
WorkspaceQuoteVersion
object
id
required
Id
string
number
required
Number
integer
status
required
Status
string
Allowed values: draft superseded current
currency
required
Currency
string
lines
required
Lines
Array<object>
WorkspaceQuoteLine
object
description
required
Description
string
quantity
required
Quantity
integer
unit_amount_minor
required
Unit Amount Minor
integer
amount_minor
required
Amount Minor
integer
subtotal_minor
required
Subtotal Minor
integer
discount_minor
required
Discount Minor
integer
tax_treatment
required
Tax Treatment
string
Allowed values: not_calculated exclusive inclusive exempt
tax_minor
required
Tax Minor
integer
total_minor
required
Total Minor
integer
deposit_minor
required
Deposit Minor
integer
terms
required
Any of:
string
expires_at
required
Any of:
string format: date-time
recipient_email
required
Any of:
string
digest
required
Digest
string
pricing_review
required
Pricing Review
string
Allowed values: none standard pricing_override
approval
required
WorkspaceQuoteApproval
object
state
required
State
string
Allowed values: not_required owner_override awaiting_review approved changes_requested declined expired stale used
approval_id
required
Any of:
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
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
reason
required
Any of:
string
acceptance
required
Any of:
WorkspaceQuoteAcceptance
object
id
required
Id
string
accepted_via
required
Accepted Via
string
Allowed values: portal recorded esign
accepted_name
required
Any of:
string
accepted_at
required
Accepted At
string format: date-time
revoked_at
required
Any of:
string format: date-time
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
created_at
required
Created At
string format: date-time
versions
required
Versions
Array<object>
WorkspaceQuoteVersion
object
id
required
Id
string
number
required
Number
integer
status
required
Status
string
Allowed values: draft superseded current
currency
required
Currency
string
lines
required
Lines
Array<object>
WorkspaceQuoteLine
object
description
required
Description
string
quantity
required
Quantity
integer
unit_amount_minor
required
Unit Amount Minor
integer
amount_minor
required
Amount Minor
integer
subtotal_minor
required
Subtotal Minor
integer
discount_minor
required
Discount Minor
integer
tax_treatment
required
Tax Treatment
string
Allowed values: not_calculated exclusive inclusive exempt
tax_minor
required
Tax Minor
integer
total_minor
required
Total Minor
integer
deposit_minor
required
Deposit Minor
integer
terms
required
Any of:
string
expires_at
required
Any of:
string format: date-time
recipient_email
required
Any of:
string
digest
required
Digest
string
pricing_review
required
Pricing Review
string
Allowed values: none standard pricing_override
approval
required
WorkspaceQuoteApproval
object
state
required
State
string
Allowed values: not_required owner_override awaiting_review approved changes_requested declined expired stale used
approval_id
required
Any of:
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
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
reason
required
Any of:
string
acceptance
required
Any of:
WorkspaceQuoteAcceptance
object
id
required
Id
string
accepted_via
required
Accepted Via
string
Allowed values: portal recorded esign
accepted_name
required
Any of:
string
accepted_at
required
Accepted At
string format: date-time
revoked_at
required
Any of:
string format: date-time
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
created_at
required
Created At
string format: date-time
share_links
required
Share Links
Array<object>
WorkspaceShareLink
object
id
required
Id
string
purpose
required
Purpose
string
Allowed values: quote booking payment
quote_version_id
required
Quote Version Id
string
version_number
required
Any of:
integer
state
required
State
string
Allowed values: live expired revoked superseded voided
expires_at
required
Expires At
string format: date-time
revoked_at
required
Any of:
string format: date-time
last_viewed_at
required
Any of:
string format: date-time
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
created_at
required
Created At
string format: date-time
payments
required
Payments
Array<object>
WorkspacePaymentRequest
object
id
required
Id
string
quote_id
required
Any of:
string
quote_version_id
required
Any of:
string
kind
required
Kind
string
Allowed values: deposit full
amount_minor
required
Amount Minor
integer
currency
required
Currency
string
status
required
Status
string
Allowed values: draft approved link_created processing paid partially_paid failed refunded disputed cancelled expired
paid_minor
required
Paid Minor
integer
refunded_minor
required
Refunded Minor
integer
provider
required
Provider
string
Allowed values: stripe square
environment
required
Environment
string
Allowed values: test live
failure_reason
required
Any of:
string
paid_at
required
Any of:
string format: date-time
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
shareable
required
Shareable
boolean
share_blocker
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
revision
required
Revision
integer
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
Example
{
  "link": {
    "purpose": "quote",
    "state": "live"
  },
  "quote": {
    "status": "draft",
    "current_version": {
      "status": "draft",
      "tax_treatment": "not_calculated",
      "pricing_review": "none",
      "approval": {
        "state": "not_required"
      },
      "acceptance": {
        "accepted_via": "portal"
      }
    },
    "versions": [
      {
        "status": "draft",
        "tax_treatment": "not_calculated",
        "pricing_review": "none",
        "approval": {
          "state": "not_required"
        },
        "acceptance": {
          "accepted_via": "portal"
        }
      }
    ],
    "share_links": [
      {
        "purpose": "quote",
        "state": "live"
      }
    ],
    "payments": [
      {
        "kind": "deposit",
        "status": "draft",
        "provider": "stripe",
        "environment": "test"
      }
    ]
  }
}

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