Organizations

Assign a personal mailbox

Assigns a personal address to an existing member. Only organization owners and admins may assign it; the member receives the sole user grant.

POST
/v1/organizations/members/{userId}/personal-mailbox

Assigns a personal address to an existing member. Only organization owners and admins may assign it; the member receives the sole user grant. Returns the mailbox ID without granting the assigner access.

Authorization

apiKey
headerx-api-key<token>

Path Parameters

userId*string
Match^user_[0-9a-hjkmnp-tv-z]{16,24}$

Request Body

application/json
  1. body
mailboxAddress*string

Response Body

Success

application/json
  1. response
mailboxId*MailboxId
Match^mbx_[0-9a-hjkmnp-tv-z]{16,24}$
Example Request
import { createClient } from "samva";const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });const result = await samva.organizations.assignPersonalMailbox({  "userId": "example",  "mailboxAddress": "example"});
Example Response
{  "mailboxId": "string"}

Related documentation