Skip to main content

Workspace management

All endpoints under /v1/workspaces/:workspaceId. Auth: Bearer + x-workspace-id. Many require admin role.

PATCH /v1/workspaces/:workspaceId​

Update workspace (e.g. name).

Body: { "name": "New Workspace Name" }

Response (200): Updated workspace. Admin required.

Example:

curl -X PATCH https://api.inboxops.app/v1/workspaces/ws-123 \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "x-workspace-id: ws-123" \
  -H "Content-Type: application/json" \
  -d '{"name":"New Name"}'

Members​

  • GET .../members — List members. Response: array of members (id, email, role).
  • PATCH .../members/:userId — Update role. Body: { "role": "admin" | "agent" | "viewer" }. Admin required.
  • DELETE .../members/:userId — Remove member. Admin required; cannot remove the last admin.

Example (list):

curl -X GET https://api.inboxops.app/v1/workspaces/ws-123/members \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "x-workspace-id: ws-123"

Domains​

  • GET .../domains — List allowed domains.
  • POST .../domains — Add domain. Body: { "domain": "example.com" }. Admin required.
  • DELETE .../domains/:domainId — Remove domain. Admin required.

Invitations​

  • GET .../invitations — List pending invitations.
  • POST .../invitations — Create invitation. Body: { "email": "user@example.com", "role": "agent" }. Admin required.
  • DELETE .../invitations/:invitationId — Cancel invitation. Admin required.

Example (invite):

curl -X POST https://api.inboxops.app/v1/workspaces/ws-123/invitations \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "x-workspace-id: ws-123" \
  -H "Content-Type: application/json" \
  -d '{"email":"newuser@example.com","role":"agent"}'

SLA​

  • GET .../sla — Get SLA config (response/resolution targets, business hours).
  • GET .../sla/dashboard — Get SLA dashboard data.
  • PUT .../sla — Update SLA config. Body: product-specific. Admin required.

Example (get SLA):

curl -X GET https://api.inboxops.app/v1/workspaces/ws-123/sla \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "x-workspace-id: ws-123"

Automation rules​

  • GET .../automation-rules — List rules.
  • GET .../automation-rules/:ruleId — Get one rule.
  • POST .../automation-rules — Create rule. Body: conditions and actions. Admin required.
  • PUT .../automation-rules/:ruleId — Update rule. Admin required.
  • DELETE .../automation-rules/:ruleId — Delete rule. Admin required.

API tokens​

  • GET .../api-tokens — List API tokens (metadata only; token values are not returned). Admin required.
  • POST .../api-tokens — Create token. Response includes the token value once. Admin required.
  • DELETE .../api-tokens/:tokenId — Revoke token. Admin required.

Example (list tokens):

curl -X GET https://api.inboxops.app/v1/workspaces/ws-123/api-tokens \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "x-workspace-id: ws-123"