Organizations
Invite an organization member
Invites a member with a personal mailbox address. View request and response details for this Samva email API endpoint.
POST
Invites a member with a personal mailbox address. A namespace confines the member and their credentials to its resources and requires a verified receiving domain in that namespace.
apiKeyheader
x-api-key<token>application/json- body
email*stringMatch
^(?=[^@]{1,64}@)[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+)*@[^\s@/\\:#?%[\]\p{Cc}]+[.\u3002\uff0e\uff61][^\s@/\\:#?%[\]\p{Cc}]+$role*stringValue in
"member""admin""mail_user"mailboxAddress*stringnamespaceId?|nullSuccess
application/json- response
id*InvitationIdMatch
^inv_[0-9a-hjkmnp-tv-z]{16,24}$email*stringrole*stringValue in
"member""admin""mail_user"namespaceId*|nullmailboxAddress*stringstatus*"pending"Value in
"pending"import { createClient } from "samva";
const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });
const result = await samva.organizations.inviteMember({
"email": "example",
"role": "member",
"mailboxAddress": "example"
});Example Response
{
"id": "string",
"email": "string",
"role": "member",
"namespaceId": "string",
"mailboxAddress": "string",
"status": "pending"
}