Praecise Platform
Menu

Rivier/ Reference/ workspace

Load clients from CSV text

post/org/{orgId}/clients/import

Load clients from CSV text. With apply false (the default) it shows what would be created, changed or skipped and writes nothing.

Before you call

Credential
Authorization: Bearer $KEY
Scope
workspace:write
Mcp
rivier_clients_import
Graphql
Mutation.workspaceOrgClientImport
Sdk
workspace.orgClient.import
Cli
clients import

Parameters

  • orgIdstring (uuid)required
    In the path

Request bodyapplication/json, required

  • csvstringrequired
    At most 1000000 characters.
  • applyboolean
    Default: false.

Responses

  • 200application/json
    Success
    • appliedbooleanrequired
    • rowslist of objectrequired
      • linenumberrequired
      • actionstringrequired
        One of: create, update, unchanged, skip.
      • namestringrequired
      • emailstringrequired
      • reasonstring
      • clientIdstring (uuid)
    • summaryobjectrequired
      • createnumberrequired
      • updatenumberrequired
      • unchangednumberrequired
      • skipnumberrequired
  • 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