Workspace Settings

Configure your workspace name, email tracking, team members, and billing. You can manage these settings through the Dashboard or the API.

Workspace Configuration

Via Dashboard

1. Navigate to Settings in the sidebar
2. On the Workspace tab:
   • Workspace Name — Edit your workspace display name
   • Workspace Slug — View your workspace identifier (read-only)
   • Track Opens — Toggle invisible tracking pixel insertion for emails
   • Track Clicks — Toggle link rewriting for click tracking
3. Click Save to apply changes

Via API

# Get current workspace
curl https://api.zyphr.dev/v1/workspaces/me \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

# Update workspace settings
curl -X PATCH https://api.zyphr.dev/v1/workspaces/WORKSPACE_ID \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Company Notifications",
    "settings": {
      "track_opens": true,
      "track_clicks": true
    }
  }'

Team Management

Inviting Team Members

Via Dashboard

1. Navigate to Settings → Team tab
2. Click Invite Member
3. Enter the email address
4. Select a role (Admin or Member)
5. Click Send Invite

The invited user receives an email with a link to join your workspace.

Via API

curl -X POST https://api.zyphr.dev/v1/workspaces/WORKSPACE_ID/members/invite \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "teammate@company.com",
    "role": "admin"
  }'

Managing Members

Via Dashboard

On the Team tab you can:

• View all team members with their role, join date, and last login
• Change a member's role (Admin ↔ Member)
• Remove a member from the workspace
• View and manage pending invitations (resend or revoke)

Via API

# List workspace members
curl https://api.zyphr.dev/v1/workspaces/WORKSPACE_ID/members \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

# Update a member's role
curl -X PATCH https://api.zyphr.dev/v1/workspaces/WORKSPACE_ID/members/USER_ID \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "role": "admin" }'

# Remove a member
curl -X DELETE https://api.zyphr.dev/v1/workspaces/WORKSPACE_ID/members/USER_ID \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

# List pending invitations
curl https://api.zyphr.dev/v1/workspaces/WORKSPACE_ID/invitations \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

Roles

Role	Permissions
Owner	Full workspace control including billing and deletion
Admin	Full access except billing management
Member	View and send messages, limited configuration

Team Size Limits

Plan	Max Members
Free	1
Starter	5
Professional	25
Enterprise	Unlimited

Appearance

Via Dashboard

1. Navigate to Settings → Appearance tab
2. Choose your preferred theme: Dark, Light, or System
3. The preference is saved per user

Plan & Billing

Via Dashboard

1. Navigate to Settings → Plan & Billing tab
2. View your current plan and usage limits
3. Upgrade Plan — Click to view available plans and upgrade
4. Payment Methods — Add, remove, or set a default payment method
5. Billing History — View invoices and download receipts

Via API

# Get current subscription
curl https://api.zyphr.dev/v1/billing/subscription \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

# Change plan
curl -X POST https://api.zyphr.dev/v1/billing/subscription/plan/change \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "plan": "professional" }'

# Add a payment method
curl -X POST https://api.zyphr.dev/v1/billing/payment-method \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "payment_method_id": "pm_..." }'

# List invoices
curl https://api.zyphr.dev/v1/billing/invoices \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

# Open Stripe customer portal
curl -X POST https://api.zyphr.dev/v1/billing/portal-session \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

Usage Monitoring

Via Dashboard

1. Navigate to Usage in the sidebar
2. View usage metrics against your plan limits:
   • Emails sent this month
   • Active API keys
   • Team members
   • Verified domains
3. Switch between tabs: Usage History, Daily Usage, MAU by Application
4. Download usage reports as CSV

Via API

# Get current month usage
curl https://api.zyphr.dev/v1/usage/current-month \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

# Get daily usage breakdown
curl "https://api.zyphr.dev/v1/usage/daily?start_date=2026-02-01&end_date=2026-02-28" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

# Get quota vs plan limits
curl https://api.zyphr.dev/v1/usage/quota \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"