HAhappyscribe
Organization memberships

Add a membership

Adds a user to the workspace. If the email belongs to an existing HappyScribe user they become a member instantly (201 Created); otherwise an invitation email is sent (202 Accepted).

Requires an owner or admin role. Only the admin and member roles can be assigned through this endpoint.

post/organization_memberships

Request

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

Request body

organization_idstring required

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

emailstring required

Email address of the user to add.

role'admin' | 'member' required

Role to assign.

Example request

{
  "organization_id": "wks_01k6a2r9s8x7c2dvq3m5n6p4ab"
}

Response

The email belongs to an existing user — membership created immediately.

Example response

{
  "member": {
    "id": 9001,
    "organization_id": "wks_01k6a2r9s8x7c2dvq3m5n6p4ab",
    "organization_name": "Acme Corp",
    "email": "alice@acme.com",
    "name": "Alice Smith",
    "role": "admin",
    "created_at": "2024-02-01T10:00:00.000Z",
    "updated_at": "2024-05-12T11:30:00.000Z"
  }
}

Changes

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