S
Samva
S
Samva
DashboardAPISamva DocumentationQuickstart GuideAuthentication

API Reference

Email Management

Conversation Management

Configuration

Analytics & Operations

Get OrganizationGet Organization UsageUpdate Organization
OpenAPI Specification
API ReferenceOrganizations

Update Organization

PATCH
/organizations/current

Authorization

apiKey
X-API-Key<token>

API key for authentication

In: header

Request Body

application/json

name?string

Organization name

Length1 <= length <= 100
slug?string

URL-friendly slug

Length3 <= length <= 50
billingEmail?string

Billing contact email

Formatemail
countryCode?string

ISO 3166-1 alpha-2 country code

Length2 <= length <= 2
currency?string

ISO 4217 currency code

Length3 <= length <= 3
timezone?string

IANA timezone

logo?string

Logo URL

Formaturi
isActive?boolean

Whether organization is active

metadata?

Custom metadata

Response Body

application/json

curl -X PATCH "https://samva.app/api/v1/organizations/current" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "string",
  "name": "string",
  "slug": "string",
  "logo": "string",
  "stripeCustomerId": "string",
  "defaultCurrency": "string",
  "countryCode": "string",
  "timezone": "string",
  "billingEmail": "string",
  "plan": "string",
  "isActive": true,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "metadata": {
    "property1": null,
    "property2": null
  },
  "messagesUsed": 9007199254740991,
  "messagesUsedThisMonth": 9007199254740991,
  "smsUsed": 9007199254740991,
  "smsUsedThisMonth": 9007199254740991,
  "whatsappUsed": 9007199254740991,
  "whatsappUsedThisMonth": 9007199254740991,
  "emailUsed": 9007199254740991,
  "emailUsedThisMonth": 9007199254740991,
  "participantsUsed": 9007199254740991,
  "conversationsUsed": 9007199254740991,
  "teamMembersUsed": 9007199254740991,
  "messagesResetAt": "2019-08-24T14:15:22Z"
}

Get Organization Usage

Previous Page

Get Download URL

Next Page

curl -X PATCH "https://samva.app/api/v1/organizations/current" \
  -H "Content-Type: application/json" \
  -d '{}'