Rivier/ Reference/ workspace

Change any part of a client; fields left out stay as they are

patch/org/{orgId}/clients/{id}

Before you call

Credential
Authorization: Bearer $KEY
Scope
workspace:write
Mcp
rivier_clients_update
Graphql
Mutation.workspaceOrgClientUpdate
Sdk
workspace.orgClient.update
Cli
clients update

Parameters

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

Request bodyapplication/json, required

  • namestring
    At most 200 characters.
  • legalNamestring
    Default: . At most 200 characters.
  • emailstring (email)
    Default: .
  • phonestring
    Default: . At most 60 characters.
  • addressstring
    Default: . At most 1000 characters.
  • countrystring
    Default: . At most 2 characters. Pattern: ^([A-Za-z]{2})?$.
  • taxIdstring
    Default: . At most 60 characters.
  • registrationstring
    Default: . At most 60 characters.
  • currencystring or null
    Default: null.
  • languagestring
    Default: en. At most 20 characters. Pattern: ^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$.
  • paymentDaysinteger or null
    Default: null.
  • notesstring
    Default: . At most 4000 characters.
  • tagslist of string
    Default: [].
  • projectIdstring (uuid) or null
    Default: null.

Responses

  • 200application/json
    Success
    • clientobjectrequired
      • idstring (uuid)required
      • organizationIdstring (uuid)required
      • namestringrequired
      • legalNamestringrequired
      • emailstringrequired
      • phonestringrequired
      • addressstringrequired
      • countrystringrequired
      • taxIdstringrequired
      • registrationstringrequired
      • currencystring or nullrequired
      • languagestringrequired
      • paymentDaysnumber or nullrequired
      • notesstringrequired
      • tagslist of stringrequired
      • projectIdstring (uuid) or nullrequired
      • createdBystringrequired
      • createdAtstringrequired
      • updatedAtstringrequired
      • archivedAtstring or nullrequired
  • 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