Samva
DashboardAPI
ChannelsPlatformMailboxesDevelopersEmail templatesIntegrationsAPI Reference
Organizations

Create an organization

Creates a new organization under the current billing account and returns it. Use this endpoint to create an organization through the Samva email API.

POST
/v1/organizations

Creates a new organization under the current billing account and returns it.

Authorization

apiKey
headerx-api-key<token>

Request Body

application/json
  1. body
name*string
Lengthlength <= 120

Response Body

Organization

application/json
  1. response
id*string
billingAccountId*string
name*string
slug*string
avatarUrl*|

URL of the organization's avatar image, hosted by Samva. Null when no avatar is set.

defaultRegion*|null
timezone*string
plan*string
isActive*boolean
createdAt*string
updatedAt*string
metadata*|null
replyToDefault*array<string>|null
emailFooterEnabledDefault*boolean|null
messagesUsed*number
messagesUsedThisMonth*number
smsUsed*number
smsUsedThisMonth*number
whatsappUsed*number
whatsappUsedThisMonth*number
emailUsed*number
emailUsedThisMonth*number
contactsUsed*number
conversationsUsed*number
teamMembersUsed*number
messagesResetAt*string|null
Example Request
import { createClient } from "samva";const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });const result = await samva.organizations.create({  "name": "example"});
Example Response
{  "id": "string",  "billingAccountId": "string",  "name": "string",  "slug": "string",  "avatarUrl": "string",  "defaultRegion": "string",  "timezone": "string",  "plan": "string",  "isActive": true,  "createdAt": "string",  "updatedAt": "string",  "metadata": {    "property1": "string",    "property2": "string"  },  "replyToDefault": [    "string"  ],  "emailFooterEnabledDefault": true,  "messagesUsed": 0,  "messagesUsedThisMonth": 0,  "smsUsed": 0,  "smsUsedThisMonth": 0,  "whatsappUsed": 0,  "whatsappUsedThisMonth": 0,  "emailUsed": 0,  "emailUsedThisMonth": 0,  "contactsUsed": 0,  "conversationsUsed": 0,  "teamMembersUsed": 0,  "messagesResetAt": "string"}

Related documentation

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.

Get the organization avatar upload URL

Returns where to upload the organization avatar. View request and response details for this Samva email API endpoint.