Archive a client: hidden from lists and pickers, its history and documents kept

Before you call

Credential

Authorization: Bearer $KEY

Scope

workspace:write

Sdk

workspace.orgClient.archive

Cli

clients archive

Parameters

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

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