Organisations and projects
Organisations, projects, members, roles, branding and account tokens.
Scopes for this area: workspace:read, workspace:write and workspace:admin.
134 operations
product
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /products | The products of the project. | read | rivier workspace product list |
| POST | /products | Add a product. | write | rivier workspace product create |
| GET | /products/{id} | A product with its profile. | read | rivier workspace product get |
| PATCH | /products/{id} | Change a product. | write | rivier workspace product update |
| POST | /products/{id}/archive | Take a product out of use. | write | rivier workspace product archive |
| POST | /products/{id}/restore | Bring an archived product back. | write | rivier workspace product restore |
| GET | /products/{id}/links | The brand items a product uses. | read | rivier workspace product links |
| POST | /products/{id}/links | Attach an asset or collection to a product. | write | rivier workspace product link |
| DELETE | /products/{id}/links/{kind}/{refId} | Detach a brand item from a product. | write | rivier workspace product unlink |
resource
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /resources | Links, documents and handles kept at a level. | read | rivier workspace resource list |
| POST | /resources | Keep a resource at a level. | write | rivier workspace resource add |
| DELETE | /resources/{id} | Remove a resource. | write | rivier workspace resource remove |
overview
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /workspace | The workspace in one read: agents, connections, what is waiting. | read | rivier workspace overview get |
| GET | /workspace/summary | Counts for the dashboard. | read | rivier workspace overview summary |
| GET | /workspace/home | The home screen's data. | read | rivier workspace overview home |
| GET | /workspace/you | The signed-in person, their role and workspace. | read | rivier workspace overview you |
| GET | /workspace/queue | Everything that arrived and still needs a person. | read | rivier workspace overview queue |
activity
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /workspace/activity | What agents did, newest first. | read | rivier workspace activity list |
| GET | /workspace/activity.csv | The activity log as CSV. | read | rivier workspace activity csv |
setup
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /workspace/setup/guide | The setup checklist and what is done. | read | rivier workspace setup guide |
portfolio
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /workspace/portfolio | Every workspace of the organisation at a glance. | read | rivier workspace portfolio get |
gap
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /workspace/gaps | Questions customers ask that the knowledge cannot answer. | read | rivier workspace gap list |
| POST | /workspace/gaps/page | Draft a page that closes a gap. | write | rivier workspace gap page |
watch
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /workspace/watch | Answers drafted in watch mode, awaiting a verdict. | read | rivier workspace watch list |
| POST | /workspace/watch/{id}/verdict | Say whether a drafted answer was good. | write | rivier workspace watch verdict |
service
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| POST | /workspace/run | Run one action of a connected service now. | write | rivier workspace service run |
brand
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /workspace/brand | The business's name, domain, sender address and accent. | read | rivier workspace brand get |
| PUT | /workspace/brand | Change the business profile. | write | rivier workspace brand update |
people
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /workspace/people | Who has a role in the workspace. | read | rivier workspace people list |
| POST | /workspace/people | Invite a person with a role. | admin | rivier workspace people invite |
| DELETE | /workspace/people/{id} | Remove a person. | admin | rivier workspace people remove |
| PATCH | /workspace/people/{id} | Change a person's role. | admin | rivier workspace people set role |
plan
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /workspace/plan | The plan and what it allows. | read | rivier workspace plan get |
organization
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /organizations | The organisations the person belongs to. | read | rivier workspace organization list |
| POST | /organizations | Create an organisation. An account token needs account:write. | admin | rivier workspace org create |
| PATCH | /organizations/{id} | Rename an organisation. | admin | rivier workspace organization update |
| DELETE | /organizations/{id} | Delete an organisation. | admin | rivier workspace organization delete |
| POST | /organizations/{id}/activate | Work inside an organisation. | admin | rivier workspace organization activate |
| GET | /organizations/{id}/compliance/profile | An organisation's compliance defaults. | read | rivier workspace organization compliance profile |
| PUT | /organizations/{id}/compliance/profile | Set an organisation's compliance defaults. | admin | rivier workspace organization set compliance profile |
member
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /organizations/{id}/members | An organisation's members and which invitations are still pending. An account token needs account:members. | read | rivier workspace org member list |
| POST | /organizations/{id}/members | Invite a member by address with a role, and an optional displayName and language for the invitation mail. An address with no account gets a link to set a password. An account token needs account:members and can invite approver, editor, member or viewer, never admin or owner. | admin | rivier workspace org member invite |
| PATCH | /organizations/{id}/members/{mid} | Change a member's role. An account token needs account:members, can set approver, editor, member or viewer, and cannot change an admin or owner. | admin | rivier workspace org member role |
| DELETE | /organizations/{id}/members/{mid} | Remove a member. An account token needs account:members and cannot remove an admin or owner. | admin | rivier workspace org member remove |
org workspace
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /organizations/{id}/workspaces | An organisation's workspaces. | read | rivier workspace org workspace list |
| POST | /organizations/{id}/workspaces | Add a workspace. | admin | rivier workspace org workspace create |
| DELETE | /organizations/{id}/workspaces/{wid} | Remove a workspace. | admin | rivier workspace org workspace delete |
| PATCH | /organizations/{id}/workspaces/{wid} | Rename a workspace, or move it to another organisation by giving organizationId (an owner or admin of both; a person signs in for this, a key cannot). | admin | rivier workspace org workspace rename |
| GET | /organizations/{id}/workspaces/archived | The archived workspaces. | read | rivier workspace org workspace archived |
| POST | /organizations/{id}/workspaces/{wid}/restore | Bring an archived workspace back, within the plan's limit. | admin | rivier workspace org workspace restore |
| GET | /organizations/{id}/workspaces/{wid}/retire-plan | What retiring an archived workspace removes, by area with counts and sizes, what stops it, and when the schedule would retire it. | read | rivier workspace org workspace retire plan |
| POST | /organizations/{id}/workspaces/{wid}/retire | Remove an archived workspace for good. The name is typed and the loss acknowledged; the domain registration and DNS are never touched. | admin | rivier workspace org workspace retire |
| GET | /organizations/{id}/workspaces/{wid}/clear-plan | What clearing some areas of a workspace removes, and which other areas must be cleared with them. | read | rivier workspace org workspace clear plan |
| POST | /organizations/{id}/workspaces/{wid}/clear | Remove the data of some areas, or all of them, and keep the workspace, its settings, keys, members, plan and domains. | admin | rivier workspace org workspace clear |
| POST | /organizations/{id}/workspaces/{wid}/export | Make the export of a workspace's records, kept for seven days. | admin | rivier workspace org workspace export |
| GET | /organizations/{id}/workspaces/{wid}/export | Download the export made for a workspace. | read | rivier workspace org workspace export download |
profile
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /account/profile | The signed-in person's profile: name, language, time zone, formats, accessibility and theme. | read | rivier workspace profile get |
| PATCH | /account/profile | Change any part of the profile. | write | rivier workspace profile update |
notification
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /account/notifications | Notification choices per topic and channel, digest and quiet hours; a project id gives that project's override. | read | rivier workspace notification get |
| PUT | /account/notifications | Change notification choices. Security email cannot be switched off. | write | rivier workspace notification set |
security
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /account/security | Where the person is signed in, a pending deletion, and where passkeys are managed. | read | rivier workspace security get |
account data
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| POST | /account/export | Everything held about the person, as JSON. | write | rivier workspace account data export |
account deletion
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /account/delete | Whether a deletion of the account is waiting, and the phrase to type. | read | rivier workspace account deletion get |
| POST | /account/delete | Ask for the account to be deleted after a 14-day cooling-off. | write | rivier workspace account deletion request |
| DELETE | /account/delete | Cancel a pending account deletion. | write | rivier workspace account deletion cancel |
account token
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /account/tokens | The account's tokens: name, scopes, organisation, last use and expiry. Never a secret. | read | rivier workspace account token list |
| POST | /account/tokens | Make an account token for the command line or an agent. The secret is shown once. Needs a signed-in person; a token cannot make a token. | write | rivier workspace account token create |
| POST | /account/tokens/{id}/rotate | Replace a token with a twin; the old one keeps working for the overlap. The new secret is shown once. | write | rivier workspace account token rotate |
| DELETE | /account/tokens/{id} | Revoke a token at once. | write | rivier workspace account token revoke |
org profile
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /organizations/{id}/profile | The organisation's legal entity, address, billing contact, defaults and data region in words. | read | rivier workspace org profile get |
| PATCH | /organizations/{id}/profile | Change the organisation's profile (owner, admin). | admin | rivier workspace org profile update |
org capability
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /organizations/{id}/capabilities | What the person can do in the organisation, with the reason for each thing they cannot. | read | rivier workspace org capability list |
role
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /organizations/{id}/roles | The roles in plain words. | read | rivier workspace role list |
invitation
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /organizations/{id}/invitations | Invitations not yet accepted, with state and expiry. | read | rivier workspace invitation list |
| POST | /organizations/{id}/members/{mid}/resend | Send an invitation again with a new expiry. | admin | rivier workspace invitation resend |
| DELETE | /organizations/{id}/members/{mid}/invitation | Withdraw an invitation that was not accepted. | admin | rivier workspace invitation revoke |
audit
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /organizations/{id}/audit | Who did what in the organisation; filter by action, actor and dates. | read | rivier workspace audit list |
| GET | /organizations/{id}/audit.csv | The audit log as CSV. | read | rivier workspace audit csv |
transfer
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /organizations/{id}/transfer | A waiting ownership hand-over, if any. | read | rivier workspace transfer get |
| POST | /organizations/{id}/transfer | Hand ownership to a member; they become owner when they accept. | admin | rivier workspace transfer request |
| DELETE | /organizations/{id}/transfer | Cancel a waiting hand-over. | admin | rivier workspace transfer cancel |
| POST | /organizations/{id}/transfer/accept | Accept ownership that was handed to you. | admin | rivier workspace transfer accept |
org deletion
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /organizations/{id}/delete-request | Whether deletion of the organisation is waiting, and the phrase to type. | read | rivier workspace org deletion get |
| POST | /organizations/{id}/delete-request | Ask for the organisation to be deleted after a 14-day cooling-off. | admin | rivier workspace org deletion request |
| DELETE | /organizations/{id}/delete-request | Cancel a pending organisation deletion. | admin | rivier workspace org deletion cancel |
org retention
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /organizations/{id}/archive-retention | How many days an archived workspace is kept before it is retired, with the allowed range. | read | rivier workspace org retention get |
| PUT | /organizations/{id}/archive-retention | Change how long archived workspaces are kept (30 to 365 days). | admin | rivier workspace org retention set |
org domain
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /organizations/{id}/domains | The organisation's domains across its workspaces, and whether ownership is proven by the DNS record. | read | rivier workspace org domain list |
role definition
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /organizations/{id}/role-definitions | The permission table: the built-in roles and the organisation's custom roles. | read | rivier workspace role definition list |
| POST | /organizations/{id}/role-definitions | Make a custom role: a built-in role plus areas granted and denied. | admin | rivier workspace role definition create |
| PATCH | /organizations/{id}/role-definitions/{rid} | Change a custom role. | admin | rivier workspace role definition update |
| DELETE | /organizations/{id}/role-definitions/{rid} | Archive a custom role; people keep the built-in role it was based on. | admin | rivier workspace role definition archive |
role assignment
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| PUT | /workspace/people/{pid}/role-definition | Give a person on this workspace a custom role, or none. | admin | rivier workspace role assignment set |
org library
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| POST | /org-library/items | Share one of this project's templates, segments, forms or brand assets with the organisation's other projects. Sharing it again publishes a new version. | write | rivier workspace org library publish |
| GET | /org-library/items | What the organisation has shared: templates, brand assets, segments and forms, with folders and tags, and which ones this project already uses. | read | rivier workspace org library list |
| GET | /org-library/items/{id} | One shared item in full, with its versions and how many projects use it. | read | rivier workspace org library get |
| PATCH | /org-library/items/{id} | Rename a shared item, move it to a folder, tag it or set its language. | write | rivier workspace org library update |
| DELETE | /org-library/items/{id} | Take an item out of the organisation library. Copies already in projects are kept. | write | rivier workspace org library remove |
| POST | /org-library/items/{id}/versions | Publish a new version of a shared item from this project's changed copy. Projects using it are offered the update. | write | rivier workspace org library new version |
| POST | /org-library/items/{id}/use | Use a shared item in this project: a copy that remembers where it came from. With refresh, bring an earlier copy up to the latest version. | write | rivier workspace org library use |
| GET | /org-library/updates | Copies in this project that are behind the organisation library. | read | rivier workspace org library updates |
org library settings
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /org-library/settings | Whether this organisation lets a contact's consent travel with it between projects. | read | rivier workspace org library settings get |
| PUT | /org-library/settings | Allow or forbid consent travelling with a contact between projects. A person sets this. | write | rivier workspace org library settings set |
org library contact
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| POST | /org-library/contacts/adopt | Take a contact another project shared into this one. It arrives without consent and a pending record is written; a person may carry the consent along when the organisation allows it. | write | rivier workspace org library contact adopt |
project hub
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /project-hub | The project as one page: counts of campaigns, templates, segments, lists, forms and contacts, domains, numbers and assets, the sender, recent campaigns, library updates, setup progress and what is blocking. | read | rivier workspace project hub get |
| GET | /project-hub/search | Search across the project's contacts, campaigns, templates, segments, forms, brand assets, domains, numbers and the organisation library. | read | rivier workspace project hub search |
| POST | /project-hub/campaign-from-brief | Draft a campaign from a brief: picks the segment among those that can be written to, reuses the best template (the organisation's if the project has none), writes the copy in the audience language and runs the check. It stops at a draft: a person approves it before anything is sent. | write | rivier workspace project hub draft from brief |
org client
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /org/{orgId}/clients | The organization's clients: search by name, email or tag, active ones by default (archived: include or only), paged. | read | rivier clients list |
| GET | /org/{orgId}/clients/{id} | One client with its contacts. | read | rivier clients get |
| POST | /org/{orgId}/clients | Add a client (a name is unique among the organization's active clients). Editor and above. | write | rivier clients create |
| PATCH | /org/{orgId}/clients/{id} | Change any part of a client; fields left out stay as they are. | write | rivier clients update |
| POST | /org/{orgId}/clients/{id}/archive | Archive a client: hidden from lists and pickers, its history and documents kept. | write | rivier clients archive |
| POST | /org/{orgId}/clients/{id}/restore | Bring an archived client back. | write | rivier clients restore |
| 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. | write | rivier clients import |
| GET | /org/{orgId}/clients/{id}/events | What happened to a client, newest first. | read | rivier clients events |
| GET | /org/{orgId}/clients/{clientId}/documents | Every quote, proposal and invoice of a client across the organization's projects, newest first. | read | rivier clients documents |
org contact
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /org/{orgId}/clients/{id}/contacts | The contacts of a client. | read | rivier clients contacts list |
| POST | /org/{orgId}/clients/{id}/contacts | Add a contact to a client (a name or an email address is needed; one can be primary, several can be copied by default). | write | rivier clients contacts add |
| PATCH | /org/{orgId}/clients/{id}/contacts/{contactId} | Change a contact of a client. | write | rivier clients contacts update |
| DELETE | /org/{orgId}/clients/{id}/contacts/{contactId} | Remove a contact from a client. | write | rivier clients contacts remove |
org branding
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /org/{orgId}/branding | The branding documents are printed with: names, address, tax and registration numbers, bank details, footer, accent colour, font, sender name, reply-to, and whether a logo is set. | read | rivier branding get |
| PUT | /org/{orgId}/branding | Change the branding; fields left out stay as they are. Needs an admin (a person who is owner or admin, or an admin key). | write | rivier branding set |
| PUT | /org/{orgId}/branding/logo | Set the logo (variant light or dark): base64 PNG, JPEG, WebP or SVG up to 512 KB; an SVG is sanitised. Needs an admin. | write | rivier branding logo set |
| GET | /org/{orgId}/branding/logo | The logo file (variant light or dark). | read | rivier branding logo get |
org template
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /org/{orgId}/templates | The organization's own templates (archived: include or only) with the starter gallery, optionally for one kind and language. | read | rivier templates list |
| GET | /org/{orgId}/templates/gallery | The starter gallery: four layouts per kind (minimal, classic, modern, bold) and, for proposals, four use cases, in English, Dhivehi and Arabic. | read | rivier templates gallery |
| GET | /org/{orgId}/templates/{id} | One template. | read | rivier templates get |
| POST | /org/{orgId}/templates | Make a template: by hand, from a gallery starter (fromGallery), or from a document's content (a body with lines, which drops any tax field on them). Editor and above. | write | rivier templates create |
| PATCH | /org/{orgId}/templates/{id} | Change a template; fields left out stay as they are. An editor changes templates they made, an admin any. | write | rivier templates update |
| POST | /org/{orgId}/templates/{id}/duplicate | A copy of a template (optionally named); the copy is never the default. | write | rivier templates duplicate |
| DELETE | /org/{orgId}/templates/{id} | Archive a template: out of the pickers, its copies in documents untouched. Needs an admin. | write | rivier templates archive |
| POST | /org/{orgId}/templates/{id}/default | Make a template the default of its kind (isDefault false clears it). Needs an admin. | write | rivier templates default |
| POST | /org/{orgId}/templates/apply | A copy of a template's (or a gallery starter's) content to place into a new document; nothing is saved. | write | rivier templates apply |
| POST | /org/{orgId}/templates/preview | The renderable view of a template or starter with the organization's branding and sample figures; nothing is saved. | write | rivier templates preview |