Change a proposal

Before you call

Credential

Authorization: Bearer $KEY

Scope

shop:write

Mcp

rivier_proposals_update

Graphql

Mutation.shopProposalUpdate

Sdk

shop.proposal.update

Cli

proposals update

Parameters

• idstring (uuid)required
  In the path

Request bodyapplication/json, required

• clientIdstring (uuid) or null
• contactobject
  • namestringrequired
    At most 200 characters.
  • emailstring (email)
    At most 254 characters.
  • phonestring
    At most 60 characters.
  • addressLineslist of string
    Default: [].
  • countrystring
    Pattern: ^[A-Z]{2}$.
  • vatIdstring
    At most 60 characters.
  • registrationstring
    At most 60 characters.
  • languagestring
    At most 20 characters. Pattern: ^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$.
• recipientsobject
  • tolist of object
    Default: [].
    • namestring
      Default: . At most 200 characters.
    • emailstring (email)required
      At most 254 characters.
    • contactIdstring (uuid)
  • cclist of object
    Default: [].
    • namestring
      Default: . At most 200 characters.
    • emailstring (email)required
      At most 254 characters.
    • contactIdstring (uuid)
• currencystring
  Pattern: ^[a-z]{3}$.
• languagestring
  At most 20 characters. Pattern: ^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$.
• titlestring
  At most 200 characters.
• issueDatestring
  Pattern: ^\d{4}-\d{2}-\d{2}$.
• validUntilstring
  Pattern: ^\d{4}-\d{2}-\d{2}$.
• notesstring
  At most 4000 characters.
• termsstring
  At most 10000 characters.
• paymentInstructionsstring
  At most 2000 characters.
• templateIdstring (uuid) or null
• layoutstring
  One of: minimal, classic, modern, bold.
• taxInclusiveboolean
• lineslist of object
  • descriptionstringrequired
    At most 500 characters.
  • quantitynumber
    Default: 1. At most 1000000.
  • unitstring
    Default: C62. At most 10 characters.
  • unitAmountMinorintegerrequired
    At least 0. At most 99999999999.
  • discountMinorinteger
    Default: 0. At least 0. At most 99999999999.
  • taxRateBpinteger
    At least 0. At most 10000.
  • taxCategorystring
    One of: S, Z, E, AE, K, G, O, L, M. Default: S.
  • optionalboolean
    Default: false.
  • selectedboolean
    Default: true.
• subjectstring
  At most 300 characters.
• messagestring
  At most 5000 characters.
• useCasestring
  At most 80 characters.
• sectionslist of object
  • keystringrequired
    One of: scope, deliverables, timeline, pricing, terms, custom.
  • titlestring
    Default: . At most 120 characters.
  • bodystring
    Default: . At most 20000 characters.
  • itemslist of object
    Default: [].
    • labelstringrequired
      At most 300 characters.
    • detailstring
      Default: . At most 1000 characters.
    • whenstring
      Default: . At most 60 characters.
• expectedVersioninteger
  At least 1.

Responses

• 200application/json
  Success
  • idstring (uuid)required
  • kindstringrequired
    One of: quote, proposal.
  • organizationIdstring (uuid)required
  • clientIdstring (uuid) or nullrequired
  • numberstring or nullrequired
  • statusstringrequired
    One of: draft, sent, viewed, accepted, declined, expired, void, converted.
  • currencystringrequired
  • languagestringrequired
  • titlestringrequired
  • issueDatestring or nullrequired
  • validUntilstring or nullrequired
  • subtotalMinornumberrequired
  • taxMinornumberrequired
  • totalMinornumberrequired
  • revisionnumberrequired
  • versionnumberrequired
  • convertedKindstring or nullrequired
  • convertedIdstring (uuid) or nullrequired
  • acceptedAtstring or nullrequired
  • acceptedNamestring or nullrequired
  • declinedAtstring or nullrequired
  • sentAtstring or nullrequired
  • viewedAtstring or nullrequired
  • voidedAtstring or nullrequired
  • createdBystringrequired
  • createdAtstringrequired
  • updatedAtstringrequired
• 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