Rivier/ Reference/ shop

Switch one link of a proposal off

post/proposals/{id}/links/{linkId}/revoke

Before you call

Credential
Authorization: Bearer $KEY
Scope
shop:write
Sdk
shop.proposal.linkRevoke
Cli
proposals links revoke

Parameters

  • idstring (uuid)required
    In the path
  • linkIdstring (uuid)required
    In the path

Responses

  • 200application/json
    Success
    • linkobjectrequired
      • idstring (uuid)required
      • kindstringrequired
        One of: quote, proposal, invoice.
      • docIdstring (uuid)required
      • expiresAtstring or nullrequired
      • viewsnumberrequired
      • firstViewedAtstring or nullrequired
      • lastViewedAtstring or nullrequired
      • revokedAtstring or nullrequired
      • createdBystringrequired
      • createdAtstringrequired
      • activebooleanrequired
  • 400application/json
    The request was malformed
    • errorstringrequired
    • messagestring
  • 401application/json
    No valid credential
    • errorstringrequired
    • messagestring
  • 403application/json
    The credential lacks the scope, origin or address
    • errorstringrequired
    • messagestring
  • 429application/json
    Over the key's rate limit; see Retry-After
    • errorstringrequired
    • messagestring

This page as Markdown