Invite a workspace member – POST /v1/workspaces/{workspaceId}/members

Invite a workspace member

Grants the specified workspace role to the invited email and attempts to send an invitation. Requires a direct platform user session and current administration of the workspace or its organization. A guest who already has workspace access may need no direct membership, in which case the returned role is null. New invitations and resends share a limit of 50 attempts per organization per 24 hours.

POST/v1/workspaces/{workspaceId}/members

betaplatformUserworkspace

When to use

Grant someone access to the workspace by email.

For agents

Requires the signed-in administrator’s direct platform access token.

Example

typescript

import { PermuteClient } from '@permute/sdk';

const client = new PermuteClient({ accessToken: async () => process.env.PERMUTE_ACCESS_TOKEN! });
const result = await client.workspaceMembers.invite('wksp_finance123', {
  "email": "ada@example.com",
  "role": "member"
});

Request body

json

{
  "email": "ada@example.com",
  "role": "member"
}

Response

json

{
  "data": {
    "userId": "user_example",
    "email": "ada@example.com",
    "role": "member",
    "invitationSent": true
  }
}