HAhappyscribe
Workspaces

Update a workspace

Renames the workspace, changes its metadata, or both. The caller must be an owner or admin.

patch/workspaces/{id}

Request

  • Base URL
    https://www.happyscribe.com/api/v1
  • Auth
    API key in header Authorization

Path parameters

idstring required
Example:wks_01k6a2r9s8x7c2dvq3m5n6p4ab

Workspace ID, beginning with wks_. Treat it as an opaque string. Integer workspace ids are still accepted.

Request body

namestring

New name for the workspace.

Response

The updated workspace.

idstring

Workspace ID, beginning with wks_. Treat it as an opaque string.

namestring

The workspace name, shown to its members in HappyScribe.

role'owner' | 'admin' | 'member' | 'guest'

The authenticated user's role in this workspace.

  • owner: owns the workspace.
  • admin: manages the workspace.
  • member: records and reads their own meetings.
  • guest: sees only what is shared with them.
created_atstring date-time

When it was created, in ISO 8601.

updated_atstring date-time

When it last changed, in ISO 8601.

owner_emailstring

(staff only) Email address of the workspace owner.

members_countinteger

(staff only) Number of members, excluding guests and deleted users.

is_human_transcription_allowedboolean

(staff only) Whether the workspace may order human transcription.

is_human_translation_allowedboolean

(staff only) Whether the workspace may order human translation.

email_domainsstring[]

(staff only) Domains that auto-join the workspace at sign-up.

idp_company_namesstring[]

(staff only) IdP company names configured for SSO.

currencystring

(staff only) Billing currency code, e.g. usd, eur, gbp.

metadataMetadata

Your own key-value pairs, for your ids and context. HappyScribe stores them, returns them on the object and in every webhook that carries it, and never acts on them. Up to 50 keys of up to 40 characters (no square brackets), values up to 500 characters. See metadata.

Example response

{
  "id": "wks_01k6a2r9s8x7c2dvq3m5n6p4ab",
  "name": "Acme Corp",
  "role": "owner",
  "created_at": "2024-01-15T10:30:00.000Z",
  "updated_at": "2024-02-01T14:20:00.000Z",
  "metadata": {
    "gurusup_org_id": "org_42"
  },
  "owner_email": "integrations@gurusup.com",
  "members_count": 12,
  "is_human_transcription_allowed": true,
  "is_human_translation_allowed": true,
  "email_domains": [],
  "idp_company_names": [],
  "currency": "eur"
}

Changes

No recorded changes to this operation across all 1 revision of this API.