{ "openapi": "3.1.1", "info": { "title": "lipiyo_backend | v1", "version": "1.0.0" }, "servers": [ { "url": "https://api.lipiyo.com/" } ], "paths": { "/api/v1/health": { "get": { "tags": [ "lipiyo_backend" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/attachments/upload": { "post": { "tags": [ "Attachments" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "files": { "type": "array", "items": { "$ref": "#/components/schemas/IFormFile" } } } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/attachments/{id}/{fileName}": { "get": { "tags": [ "Attachments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fileName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "inline", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/auth/register": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RegisterRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RegisterRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/auth/login": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LoginRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LoginRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/auth/me": { "get": { "tags": [ "Auth" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/auth/mailbox-login": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailboxLoginRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MailboxLoginRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MailboxLoginRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/auth/mailbox-me": { "get": { "tags": [ "Auth" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/auth/unified-login": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnifiedLoginRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UnifiedLoginRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UnifiedLoginRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/auth/forgot-password": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForgotPasswordRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ForgotPasswordRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ForgotPasswordRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/auth/reset-password": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResetPasswordRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResetPasswordRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ResetPasswordRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/auth/send-verification-code": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SendVerificationCodeRequest" } ] } }, "text/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SendVerificationCodeRequest" } ] } }, "application/*+json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SendVerificationCodeRequest" } ] } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/auth/verify-email": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyEmailRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VerifyEmailRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/VerifyEmailRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "Auth" ], "parameters": [ { "name": "email", "in": "query", "schema": { "type": "string" } }, { "name": "code", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/auth/verification-status": { "get": { "tags": [ "Auth" ], "parameters": [ { "name": "email", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/auth/sso-ticket": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SsoTicketRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SsoTicketRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SsoTicketRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/auth/sso-exchange": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SsoExchangeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SsoExchangeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SsoExchangeRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/auth/admin-mailbox-sso/{mailboxId}": { "post": { "tags": [ "Auth" ], "parameters": [ { "name": "mailboxId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/auth/central-me": { "get": { "tags": [ "Auth" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/auth/resolve-session": { "get": { "tags": [ "Auth" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/auth/session": { "get": { "tags": [ "AuthSession" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/auth/logout": { "post": { "tags": [ "AuthSession" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/public/blog/images/{fileName}": { "get": { "tags": [ "BlogPublic" ], "parameters": [ { "name": "fileName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "head": { "tags": [ "BlogPublic" ], "parameters": [ { "name": "fileName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/public/blog": { "get": { "tags": [ "BlogPublic" ], "parameters": [ { "name": "category", "in": "query", "schema": { "type": "string" } }, { "name": "tag", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 12 } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/public/blog/{slug}": { "get": { "tags": [ "BlogPublic" ], "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/domains": { "get": { "tags": [ "Domains" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Domains" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddDomainRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddDomainRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddDomainRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/domains/{id}/dns-records": { "get": { "tags": [ "Domains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/domains/{id}/check-dns": { "post": { "tags": [ "Domains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/domains/{id}/simulate-dns": { "post": { "tags": [ "Domains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/domains/{id}": { "delete": { "tags": [ "Domains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/inbound/deliver": { "post": { "tags": [ "Inbound" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InboundEmailDeliveryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InboundEmailDeliveryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/InboundEmailDeliveryRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/inbound/test-simulate": { "post": { "tags": [ "Inbound" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InboundSimulationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InboundSimulationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/InboundSimulationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/mailboxes": { "get": { "tags": [ "Mailboxes" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Mailboxes" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMailboxRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateMailboxRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateMailboxRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/mailboxes/{id}": { "get": { "tags": [ "Mailboxes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Mailboxes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/mailboxes/{id}/storage": { "get": { "tags": [ "Mailboxes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/mailboxes/{id}/recalculate-storage": { "post": { "tags": [ "Mailboxes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/mailboxes/{id}/empty-trash": { "post": { "tags": [ "Mailboxes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/mailboxes/{id}/quota": { "put": { "tags": [ "Mailboxes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateQuotaRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateQuotaRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateQuotaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/mailboxes/{id}/profile": { "put": { "tags": [ "Mailboxes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProfileRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateProfileRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateProfileRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/mailboxes/{id}/password": { "post": { "tags": [ "Mailboxes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResetPasswordRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResetPasswordRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ResetPasswordRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/mailboxes/{id}/status": { "put": { "tags": [ "Mailboxes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateStatusRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateStatusRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateStatusRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/mailboxes/{id}/suspend": { "post": { "tags": [ "Mailboxes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/mailboxes/{id}/service-access": { "put": { "tags": [ "Mailboxes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceAccessRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceAccessRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ServiceAccessRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/mailboxes/{id}/forwarding": { "put": { "tags": [ "Mailboxes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForwardingRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ForwardingRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ForwardingRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/mailboxes/{id}/auto-responder": { "put": { "tags": [ "Mailboxes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoResponderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AutoResponderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AutoResponderRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/mailboxes/{id}/security": { "put": { "tags": [ "Mailboxes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecuritySettingsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SecuritySettingsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SecuritySettingsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/mailboxes/{id}/terminate-sessions": { "post": { "tags": [ "Mailboxes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/mailboxes/{id}/aliases": { "post": { "tags": [ "Mailboxes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddAliasRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddAliasRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddAliasRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/mailboxes/{id}/aliases/{aliasAddress}": { "delete": { "tags": [ "Mailboxes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "aliasAddress", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/mailboxes/{id}/client-settings": { "get": { "tags": [ "Mailboxes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/organization-members": { "get": { "tags": [ "OrganizationMembers" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "OrganizationMembers" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddMemberRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddMemberRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddMemberRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/organization-members/{id}/role": { "put": { "tags": [ "OrganizationMembers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateRoleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateRoleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateRoleRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/organization-members/{id}": { "delete": { "tags": [ "OrganizationMembers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/payments/config": { "get": { "tags": [ "Payments" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/payments/create-order": { "post": { "tags": [ "Payments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateOrderRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/payments/verify": { "post": { "tags": [ "Payments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyPaymentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VerifyPaymentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/VerifyPaymentRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/payments/create-trial-subscription": { "post": { "tags": [ "Payments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTrialSubscriptionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateTrialSubscriptionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateTrialSubscriptionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/payments/verify-trial-subscription": { "post": { "tags": [ "Payments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyTrialSubscriptionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VerifyTrialSubscriptionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/VerifyTrialSubscriptionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/payments/history": { "get": { "tags": [ "Payments" ], "parameters": [ { "name": "organizationId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/payments/webhook": { "post": { "tags": [ "Payments" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/plans": { "get": { "tags": [ "Plans" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/plans/current": { "get": { "tags": [ "Plans" ], "parameters": [ { "name": "organizationId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/plans/subscribe": { "post": { "tags": [ "Plans" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpgradePlanRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpgradePlanRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpgradePlanRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/plans/adjust": { "post": { "tags": [ "Plans" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdjustSubscriptionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdjustSubscriptionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AdjustSubscriptionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/organizations/{organizationId}/billing-profile": { "put": { "tags": [ "Plans" ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBillingProfileRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateBillingProfileRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateBillingProfileRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/audit-events": { "get": { "tags": [ "Audit" ], "parameters": [ { "name": "organizationId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/support/contact": { "post": { "tags": [ "Support" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactInquiryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContactInquiryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ContactInquiryRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/support/website-config": { "get": { "tags": [ "Support" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/webmail/folders": { "get": { "tags": [ "Webmail" ], "parameters": [ { "name": "mailboxId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/webmail/messages": { "get": { "tags": [ "Webmail" ], "parameters": [ { "name": "mailboxId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "folder", "in": "query", "schema": { "type": "string", "default": "Inbox" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "label", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/webmail/messages/{id}": { "get": { "tags": [ "Webmail" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/webmail/messages/{id}/star": { "post": { "tags": [ "Webmail" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/webmail/messages/{id}/read": { "post": { "tags": [ "Webmail" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetReadRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetReadRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetReadRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/webmail/messages/{id}/move": { "post": { "tags": [ "Webmail" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoveMessageRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MoveMessageRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MoveMessageRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/webmail/messages/{id}/labels": { "post": { "tags": [ "Webmail" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetLabelsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetLabelsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetLabelsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/webmail/messages/bulk": { "post": { "tags": [ "Webmail" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkActionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BulkActionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BulkActionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/webmail/empty-folder": { "post": { "tags": [ "Webmail" ], "parameters": [ { "name": "folder", "in": "query", "schema": { "type": "string", "default": "Trash" } }, { "name": "mailboxId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/webmail/drafts": { "post": { "tags": [ "Webmail" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveDraftRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaveDraftRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SaveDraftRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/webmail/drafts/{id}": { "delete": { "tags": [ "Webmail" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/webmail/send": { "post": { "tags": [ "Webmail" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendMessageRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SendMessageRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SendMessageRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/webmail/contacts": { "get": { "tags": [ "Webmail" ], "parameters": [ { "name": "mailboxId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/webmail/settings": { "get": { "tags": [ "Webmail" ], "parameters": [ { "name": "mailboxId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Webmail" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSettingsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateSettingsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateSettingsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/Sheets/Spreadsheets": { "get": { "tags": [ "Spreadsheets" ], "parameters": [ { "name": "trashed", "in": "query", "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Spreadsheets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSheetRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateSheetRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateSheetRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/Sheets/Spreadsheets/{id}": { "get": { "tags": [ "Spreadsheets" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "Spreadsheets" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveSheetRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaveSheetRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SaveSheetRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "patch": { "tags": [ "Spreadsheets" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSheetMetaRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateSheetMetaRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateSheetMetaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Spreadsheets" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/Sheets/Spreadsheets/{id}/shares": { "get": { "tags": [ "Spreadsheets" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Spreadsheets" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShareSpreadsheetRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ShareSpreadsheetRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ShareSpreadsheetRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/Sheets/Spreadsheets/{id}/shares/{shareId}": { "delete": { "tags": [ "Spreadsheets" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "shareId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/Sheets/Spreadsheets/{id}/public-share": { "put": { "tags": [ "Spreadsheets" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicShareRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PublicShareRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PublicShareRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/Sheets/Spreadsheets/{id}/public": { "get": { "tags": [ "Spreadsheets" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "token", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/Drive/Files": { "get": { "tags": [ "Files" ], "parameters": [ { "name": "folderId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "starred", "in": "query", "schema": { "type": "boolean" } }, { "name": "trashed", "in": "query", "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/Drive/Files/upload": { "post": { "tags": [ "Files" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "allOf": [ { "type": "object", "properties": { "files": { "type": "array", "items": { "$ref": "#/components/schemas/IFormFile" } } } }, { "type": "object", "properties": { "parentFolderId": { "type": "string", "format": "uuid" } } } ] } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/Drive/Files/{id}/preview": { "get": { "tags": [ "Files" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/Drive/Files/{id}/download": { "get": { "tags": [ "Files" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "inline", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/Drive/Files/{id}": { "patch": { "tags": [ "Files" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFileRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateFileRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateFileRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Files" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/Drive/Folders": { "get": { "tags": [ "Folders" ], "parameters": [ { "name": "parentFolderId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "trashed", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Folders" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFolderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateFolderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateFolderRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/Drive/Folders/{id}": { "patch": { "tags": [ "Folders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFolderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateFolderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateFolderRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Folders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/Drive/Storage": { "get": { "tags": [ "Storage" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/Docs/Documents": { "get": { "tags": [ "Documents" ], "parameters": [ { "name": "trashed", "in": "query", "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Documents" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDocRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateDocRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateDocRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/Docs/Documents/{id}": { "get": { "tags": [ "Documents" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "Documents" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "share", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveDocRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaveDocRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SaveDocRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "patch": { "tags": [ "Documents" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDocMetaRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateDocMetaRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateDocMetaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Documents" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/Docs/Documents/{id}/public": { "get": { "tags": [ "Documents" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "token", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/Docs/Documents/{id}/shares": { "get": { "tags": [ "Documents" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Documents" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddShareRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddShareRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddShareRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/Docs/Documents/{id}/shares/{shareId}": { "delete": { "tags": [ "Documents" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "shareId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/Docs/Documents/{id}/public-share": { "put": { "tags": [ "Documents" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicShareRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PublicShareRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PublicShareRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/Docs/Documents/{id}/comments": { "get": { "tags": [ "Documents" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Documents" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddCommentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddCommentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddCommentRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/Docs/Documents/{id}/comments/{commentId}": { "patch": { "tags": [ "Documents" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "commentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolveCommentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResolveCommentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ResolveCommentRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/Docs/Documents/{id}/revisions": { "get": { "tags": [ "Documents" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Documents" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateRevisionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateRevisionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateRevisionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/Docs/Documents/{id}/revisions/{revisionId}/restore": { "post": { "tags": [ "Documents" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "revisionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/corp/blog/upload-image": { "post": { "tags": [ "BlogAdmin" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ContentType": { "type": "string" }, "ContentDisposition": { "type": "string" }, "Headers": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "Length": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "Name": { "type": "string" }, "FileName": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/corp/blog/posts": { "get": { "tags": [ "BlogAdmin" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "category", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 15 } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "BlogAdmin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBlogPostRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateBlogPostRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateBlogPostRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/corp/blog/posts/{id}": { "get": { "tags": [ "BlogAdmin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "BlogAdmin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBlogPostRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateBlogPostRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateBlogPostRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "BlogAdmin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/corp/blog/posts/{id}/publish": { "patch": { "tags": [ "BlogAdmin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/corp/blog/stats": { "get": { "tags": [ "BlogAdmin" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/Corp/Deliverability/status": { "get": { "tags": [ "Deliverability" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/Corp/Deliverability/freeze-mailbox/{id}": { "post": { "tags": [ "Deliverability" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FreezeMailboxRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FreezeMailboxRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FreezeMailboxRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/Corp/Impersonation/generate-token": { "post": { "tags": [ "Impersonation" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImpersonateTenantRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ImpersonateTenantRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ImpersonateTenantRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/Corp/Inquiries": { "get": { "tags": [ "Inquiries" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 20 } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/Corp/Inquiries/{id}": { "get": { "tags": [ "Inquiries" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Inquiries" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/Corp/Inquiries/{id}/status": { "patch": { "tags": [ "Inquiries" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateInquiryStatusRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateInquiryStatusRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateInquiryStatusRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/Corp/Inquiries/{id}/notes": { "post": { "tags": [ "Inquiries" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateInquiryNotesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateInquiryNotesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateInquiryNotesRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/Corp/Metrics/overview": { "get": { "tags": [ "Metrics" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/corp/plans": { "get": { "tags": [ "PlansAdmin" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "PlansAdmin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePlanRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatePlanRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatePlanRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/corp/plans/{id}": { "get": { "tags": [ "PlansAdmin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "PlansAdmin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePlanRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatePlanRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatePlanRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/corp/plans/{id}/toggle-status": { "patch": { "tags": [ "PlansAdmin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/Corp/SystemInboxes/overview": { "get": { "tags": [ "SystemInboxes" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/Corp/SystemInboxes/messages": { "get": { "tags": [ "SystemInboxes" ], "parameters": [ { "name": "mailboxId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "folder", "in": "query", "schema": { "type": "string", "default": "Inbox" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 30 } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/Corp/SystemInboxes/messages/{id}": { "get": { "tags": [ "SystemInboxes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/Corp/SystemInboxes/messages/{id}/read": { "patch": { "tags": [ "SystemInboxes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToggleReadRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ToggleReadRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ToggleReadRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/Corp/SystemInboxes/generate-sso-url": { "post": { "tags": [ "SystemInboxes" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateMailboxSsoRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GenerateMailboxSsoRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GenerateMailboxSsoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/Corp/Tenants": { "get": { "tags": [ "Tenants" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 20 } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/Corp/Tenants/{id}": { "get": { "tags": [ "Tenants" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/Corp/Tenants/{id}/extend-trial": { "post": { "tags": [ "Tenants" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtendTrialRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExtendTrialRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ExtendTrialRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/Corp/Tenants/{id}/status": { "put": { "tags": [ "Tenants" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTenantStatusRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateTenantStatusRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateTenantStatusRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/Corp/Tenants/{id}/override-seats": { "put": { "tags": [ "Tenants" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OverrideSeatsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OverrideSeatsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OverrideSeatsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/corp/website-controls": { "get": { "tags": [ "WebsiteControls" ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "WebsiteControls" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWebsiteControlsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateWebsiteControlsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateWebsiteControlsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/corp/websitecontrols": { "get": { "tags": [ "WebsiteControls" ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "WebsiteControls" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWebsiteControlsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateWebsiteControlsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateWebsiteControlsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "AddAliasRequest": { "required": [ "aliasAddress" ], "type": "object", "properties": { "aliasAddress": { "type": "string" } } }, "AddCommentRequest": { "required": [ "body", "anchorText", "parentId" ], "type": "object", "properties": { "body": { "type": "string" }, "anchorText": { "type": [ "null", "string" ] }, "parentId": { "type": [ "null", "string" ], "format": "uuid" } } }, "AddDomainRequest": { "required": [ "domainName" ], "type": "object", "properties": { "domainName": { "type": "string" } } }, "AddMemberRequest": { "required": [ "email", "role" ], "type": "object", "properties": { "email": { "type": "string" }, "role": { "type": "string" } } }, "AddShareRequest": { "required": [ "email", "permission" ], "type": "object", "properties": { "email": { "type": "string" }, "permission": { "type": "string" } } }, "AdjustSubscriptionRequest": { "required": [ "organizationId", "planCode", "billingCycle", "seats" ], "type": "object", "properties": { "organizationId": { "type": "string", "format": "uuid" }, "planCode": { "type": "string" }, "billingCycle": { "type": "string" }, "seats": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "AutoResponderRequest": { "required": [ "isEnabled", "subject", "message" ], "type": "object", "properties": { "isEnabled": { "type": "boolean" }, "subject": { "type": [ "null", "string" ] }, "message": { "type": [ "null", "string" ] } } }, "BillingDetailsInput": { "required": [ "billingName", "billingAddress", "billingCity", "billingState", "billingPostalCode", "gstin", "pan" ], "type": "object", "properties": { "billingName": { "type": [ "null", "string" ] }, "billingAddress": { "type": [ "null", "string" ] }, "billingCity": { "type": [ "null", "string" ] }, "billingState": { "type": [ "null", "string" ] }, "billingPostalCode": { "type": [ "null", "string" ] }, "gstin": { "type": [ "null", "string" ] }, "pan": { "type": [ "null", "string" ] } } }, "BulkActionRequest": { "required": [ "messageIds", "action", "targetFolder", "label", "isRead", "isStarred" ], "type": "object", "properties": { "messageIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "action": { "type": "string" }, "targetFolder": { "type": [ "null", "string" ] }, "label": { "type": [ "null", "string" ] }, "isRead": { "type": [ "null", "boolean" ] }, "isStarred": { "type": [ "null", "boolean" ] } } }, "ContactInquiryRequest": { "required": [ "name", "email", "subject", "message" ], "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "subject": { "type": "string" }, "message": { "type": "string" }, "phone": { "type": [ "null", "string" ] }, "company": { "type": [ "null", "string" ] }, "submittedAtUtc": { "type": [ "null", "string" ], "format": "date-time" } } }, "CreateBlogPostRequest": { "required": [ "title", "slug", "excerpt", "contentHtml", "featuredImageUrl", "authorName", "authorRole", "authorAvatarUrl", "category", "tagsJson", "readingTimeMinutes", "metaTitle", "metaDescription", "canonicalUrl", "status" ], "type": "object", "properties": { "title": { "type": "string" }, "slug": { "type": [ "null", "string" ] }, "excerpt": { "type": [ "null", "string" ] }, "contentHtml": { "type": [ "null", "string" ] }, "featuredImageUrl": { "type": [ "null", "string" ] }, "authorName": { "type": [ "null", "string" ] }, "authorRole": { "type": [ "null", "string" ] }, "authorAvatarUrl": { "type": [ "null", "string" ] }, "category": { "type": [ "null", "string" ] }, "tagsJson": { "type": [ "null", "string" ] }, "readingTimeMinutes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "metaTitle": { "type": [ "null", "string" ] }, "metaDescription": { "type": [ "null", "string" ] }, "canonicalUrl": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] } } }, "CreateDocRequest": { "required": [ "title", "contentHtml", "template" ], "type": "object", "properties": { "title": { "type": [ "null", "string" ] }, "contentHtml": { "type": [ "null", "string" ] }, "template": { "type": [ "null", "string" ] } } }, "CreateFolderRequest": { "required": [ "name", "parentFolderId" ], "type": "object", "properties": { "name": { "type": "string" }, "parentFolderId": { "type": [ "null", "string" ], "format": "uuid" } } }, "CreateMailboxRequest": { "required": [ "domainId", "localPart", "displayName", "password" ], "type": "object", "properties": { "domainId": { "type": "string", "format": "uuid" }, "localPart": { "type": "string" }, "displayName": { "type": "string" }, "password": { "type": "string" } } }, "CreateOrderRequest": { "required": [ "organizationId", "planCode" ], "type": "object", "properties": { "organizationId": { "type": "string", "format": "uuid" }, "planCode": { "type": "string" }, "billingCycle": { "type": [ "null", "string" ], "default": "monthly" }, "seats": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 }, "billing": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/BillingDetailsInput" } ] } } }, "CreatePlanRequest": { "required": [ "name", "code", "description", "pricePerUserMonthly", "pricePerUserYearly", "minSeats", "currency", "maxMailboxes", "maxDomains", "maxAliasesPerMailbox", "storageBytesPerMailbox", "maxAttachmentSizeBytes", "dailySendLimitPerMailbox", "includesImapSmtp", "includesCatchAll", "includesCustomBranding", "isActive" ], "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "pricePerUserMonthly": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "pricePerUserYearly": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "minSeats": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "currency": { "type": [ "null", "string" ] }, "maxMailboxes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "maxDomains": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "maxAliasesPerMailbox": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "storageBytesPerMailbox": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "maxAttachmentSizeBytes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "dailySendLimitPerMailbox": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "includesImapSmtp": { "type": "boolean" }, "includesCatchAll": { "type": "boolean" }, "includesCustomBranding": { "type": "boolean" }, "isActive": { "type": "boolean" } } }, "CreateRevisionRequest": { "required": [ "label" ], "type": "object", "properties": { "label": { "type": [ "null", "string" ] } } }, "CreateSheetRequest": { "required": [ "title", "template" ], "type": "object", "properties": { "title": { "type": [ "null", "string" ] }, "template": { "type": [ "null", "string" ] } } }, "CreateTrialSubscriptionRequest": { "required": [ "organizationId", "planCode", "billingCycle", "seats", "billing" ], "type": "object", "properties": { "organizationId": { "type": "string", "format": "uuid" }, "planCode": { "type": "string" }, "billingCycle": { "type": [ "null", "string" ] }, "seats": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "billing": { "$ref": "#/components/schemas/BillingDetailsInput" } } }, "ExtendTrialRequest": { "required": [ "days", "reason" ], "type": "object", "properties": { "days": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "reason": { "type": [ "null", "string" ] } } }, "ForgotPasswordRequest": { "required": [ "email" ], "type": "object", "properties": { "email": { "type": "string" } } }, "ForwardingRequest": { "required": [ "isEnabled", "forwardingAddress" ], "type": "object", "properties": { "isEnabled": { "type": "boolean" }, "forwardingAddress": { "type": [ "null", "string" ] }, "keepCopy": { "type": "boolean", "default": true } } }, "FreezeMailboxRequest": { "required": [ "reason" ], "type": "object", "properties": { "reason": { "type": [ "null", "string" ] } } }, "GenerateMailboxSsoRequest": { "required": [ "mailboxId" ], "type": "object", "properties": { "mailboxId": { "type": "string", "format": "uuid" } } }, "IFormFile": { "type": "string", "format": "binary" }, "ImpersonateTenantRequest": { "required": [ "organizationId", "reason" ], "type": "object", "properties": { "organizationId": { "type": "string", "format": "uuid" }, "reason": { "type": "string" } } }, "InboundEmailDeliveryRequest": { "required": [ "senderAddress", "senderName", "recipientAddress", "subject", "bodyHtml", "bodyText", "ccAddresses", "bccAddresses", "attachmentsJson", "importance", "isSpam", "spamScore", "spamReport", "messageId" ], "type": "object", "properties": { "senderAddress": { "type": "string" }, "senderName": { "type": [ "null", "string" ] }, "recipientAddress": { "type": "string" }, "subject": { "type": [ "null", "string" ] }, "bodyHtml": { "type": [ "null", "string" ] }, "bodyText": { "type": [ "null", "string" ] }, "ccAddresses": { "type": [ "null", "string" ] }, "bccAddresses": { "type": [ "null", "string" ] }, "attachmentsJson": { "type": [ "null", "string" ] }, "importance": { "type": [ "null", "string" ] }, "isSpam": { "type": "boolean" }, "spamScore": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "spamReport": { "type": [ "null", "string" ] }, "messageId": { "type": [ "null", "string" ] } } }, "InboundSimulationRequest": { "required": [ "recipientAddress", "senderAddress", "senderName", "subject", "bodyHtml", "isSpam" ], "type": "object", "properties": { "recipientAddress": { "type": [ "null", "string" ] }, "senderAddress": { "type": [ "null", "string" ] }, "senderName": { "type": [ "null", "string" ] }, "subject": { "type": [ "null", "string" ] }, "bodyHtml": { "type": [ "null", "string" ] }, "isSpam": { "type": [ "null", "boolean" ] } } }, "LoginRequest": { "required": [ "email", "password" ], "type": "object", "properties": { "email": { "type": "string" }, "password": { "type": "string" } } }, "MailboxLoginRequest": { "required": [ "email", "password" ], "type": "object", "properties": { "email": { "type": "string" }, "password": { "type": "string" } } }, "MoveMessageRequest": { "required": [ "targetFolder" ], "type": "object", "properties": { "targetFolder": { "type": "string" } } }, "OverrideSeatsRequest": { "required": [ "seats", "reason" ], "type": "object", "properties": { "seats": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "reason": { "type": [ "null", "string" ] } } }, "PublicShareRequest": { "required": [ "enabled", "permission" ], "type": "object", "properties": { "enabled": { "type": "boolean" }, "permission": { "type": "string" } } }, "RegisterRequest": { "required": [ "email", "password", "fullName", "organizationName" ], "type": "object", "properties": { "email": { "type": "string" }, "password": { "type": "string" }, "fullName": { "type": "string" }, "organizationName": { "type": "string" }, "desiredUsername": { "type": [ "null", "string" ] }, "desiredTenantSlug": { "type": [ "null", "string" ] } } }, "ResetPasswordRequest": { "required": [ "email", "token", "newPassword" ], "type": "object", "properties": { "email": { "type": "string" }, "token": { "type": "string" }, "newPassword": { "type": "string" } } }, "ResolveCommentRequest": { "required": [ "isResolved" ], "type": "object", "properties": { "isResolved": { "type": "boolean" } } }, "SaveDocRequest": { "required": [ "title", "contentHtml", "contentJson", "wordCount", "characterCount" ], "type": "object", "properties": { "title": { "type": [ "null", "string" ] }, "contentHtml": { "type": [ "null", "string" ] }, "contentJson": { "type": [ "null", "string" ] }, "wordCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "characterCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } }, "SaveDraftRequest": { "required": [ "id", "mailboxId", "toAddresses", "ccAddresses", "bccAddresses", "subject", "bodyHtml", "attachmentsJson" ], "type": "object", "properties": { "id": { "type": [ "null", "string" ], "format": "uuid" }, "mailboxId": { "type": [ "null", "string" ], "format": "uuid" }, "toAddresses": { "type": [ "null", "string" ] }, "ccAddresses": { "type": [ "null", "string" ] }, "bccAddresses": { "type": [ "null", "string" ] }, "subject": { "type": [ "null", "string" ] }, "bodyHtml": { "type": [ "null", "string" ] }, "attachmentsJson": { "type": [ "null", "string" ] } } }, "SaveSheetRequest": { "required": [ "title", "dataJson", "rowCount", "columnCount" ], "type": "object", "properties": { "title": { "type": [ "null", "string" ] }, "dataJson": { "type": [ "null", "string" ] }, "rowCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "columnCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } }, "SecuritySettingsRequest": { "required": [ "requireTwoFactor" ], "type": "object", "properties": { "requireTwoFactor": { "type": "boolean" } } }, "SendMessageRequest": { "required": [ "mailboxId", "draftId", "toAddresses", "ccAddresses", "bccAddresses", "subject", "bodyHtml", "attachmentsJson", "importance" ], "type": "object", "properties": { "mailboxId": { "type": [ "null", "string" ], "format": "uuid" }, "draftId": { "type": [ "null", "string" ], "format": "uuid" }, "toAddresses": { "type": "string" }, "ccAddresses": { "type": [ "null", "string" ] }, "bccAddresses": { "type": [ "null", "string" ] }, "subject": { "type": "string" }, "bodyHtml": { "type": "string" }, "attachmentsJson": { "type": [ "null", "string" ] }, "importance": { "type": [ "null", "string" ] } } }, "SendVerificationCodeRequest": { "type": "object", "properties": { "email": { "type": [ "null", "string" ] } } }, "ServiceAccessRequest": { "required": [ "allowWebmail", "allowImap", "allowPop", "allowSmtp" ], "type": "object", "properties": { "allowWebmail": { "type": "boolean" }, "allowImap": { "type": "boolean" }, "allowPop": { "type": "boolean" }, "allowSmtp": { "type": "boolean" } } }, "SetLabelsRequest": { "required": [ "labels" ], "type": "object", "properties": { "labels": { "type": "array", "items": { "type": "string" } } } }, "SetReadRequest": { "required": [ "isRead" ], "type": "object", "properties": { "isRead": { "type": "boolean" } } }, "ShareSpreadsheetRequest": { "required": [ "email", "permission" ], "type": "object", "properties": { "email": { "type": "string" }, "permission": { "type": "string" } } }, "SsoExchangeRequest": { "required": [ "ticket" ], "type": "object", "properties": { "ticket": { "type": "string" } } }, "SsoTicketRequest": { "type": "object", "properties": { "targetMailboxId": { "type": [ "null", "string" ], "format": "uuid" }, "targetProduct": { "type": [ "null", "string" ] } } }, "ToggleReadRequest": { "required": [ "isRead" ], "type": "object", "properties": { "isRead": { "type": "boolean" } } }, "UnifiedLoginRequest": { "required": [ "email", "password" ], "type": "object", "properties": { "email": { "type": "string" }, "password": { "type": "string" }, "preferredType": { "type": [ "null", "string" ] } } }, "UpdateBillingProfileRequest": { "required": [ "billingName", "billingAddress", "billingCity", "billingState", "billingPostalCode", "gstin", "pan" ], "type": "object", "properties": { "billingName": { "type": [ "null", "string" ] }, "billingAddress": { "type": [ "null", "string" ] }, "billingCity": { "type": [ "null", "string" ] }, "billingState": { "type": [ "null", "string" ] }, "billingPostalCode": { "type": [ "null", "string" ] }, "gstin": { "type": [ "null", "string" ] }, "pan": { "type": [ "null", "string" ] } } }, "UpdateBlogPostRequest": { "required": [ "title", "slug", "excerpt", "contentHtml", "featuredImageUrl", "authorName", "authorRole", "authorAvatarUrl", "category", "tagsJson", "readingTimeMinutes", "metaTitle", "metaDescription", "canonicalUrl", "status" ], "type": "object", "properties": { "title": { "type": "string" }, "slug": { "type": [ "null", "string" ] }, "excerpt": { "type": [ "null", "string" ] }, "contentHtml": { "type": [ "null", "string" ] }, "featuredImageUrl": { "type": [ "null", "string" ] }, "authorName": { "type": [ "null", "string" ] }, "authorRole": { "type": [ "null", "string" ] }, "authorAvatarUrl": { "type": [ "null", "string" ] }, "category": { "type": [ "null", "string" ] }, "tagsJson": { "type": [ "null", "string" ] }, "readingTimeMinutes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "metaTitle": { "type": [ "null", "string" ] }, "metaDescription": { "type": [ "null", "string" ] }, "canonicalUrl": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] } } }, "UpdateDocMetaRequest": { "required": [ "title", "isStarred", "isTrashed" ], "type": "object", "properties": { "title": { "type": [ "null", "string" ] }, "isStarred": { "type": [ "null", "boolean" ] }, "isTrashed": { "type": [ "null", "boolean" ] } } }, "UpdateFileRequest": { "required": [ "name", "isStarred", "isTrashed", "parentFolderId" ], "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "isStarred": { "type": [ "null", "boolean" ] }, "isTrashed": { "type": [ "null", "boolean" ] }, "parentFolderId": { "type": [ "null", "string" ], "format": "uuid" } } }, "UpdateFolderRequest": { "required": [ "name", "isStarred", "isTrashed" ], "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "isStarred": { "type": [ "null", "boolean" ] }, "isTrashed": { "type": [ "null", "boolean" ] } } }, "UpdateInquiryNotesRequest": { "required": [ "notes", "assignedTo" ], "type": "object", "properties": { "notes": { "type": [ "null", "string" ] }, "assignedTo": { "type": [ "null", "string" ] } } }, "UpdateInquiryStatusRequest": { "required": [ "status", "notes" ], "type": "object", "properties": { "status": { "type": "string" }, "notes": { "type": [ "null", "string" ] } } }, "UpdatePlanRequest": { "required": [ "name", "description", "pricePerUserMonthly", "pricePerUserYearly", "minSeats", "maxMailboxes", "maxDomains", "maxAliasesPerMailbox", "storageBytesPerMailbox", "maxAttachmentSizeBytes", "dailySendLimitPerMailbox", "includesImapSmtp", "includesCatchAll", "includesCustomBranding", "isActive" ], "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "pricePerUserMonthly": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "pricePerUserYearly": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "minSeats": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "maxMailboxes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "maxDomains": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "maxAliasesPerMailbox": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "storageBytesPerMailbox": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "maxAttachmentSizeBytes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "dailySendLimitPerMailbox": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "includesImapSmtp": { "type": "boolean" }, "includesCatchAll": { "type": "boolean" }, "includesCustomBranding": { "type": "boolean" }, "isActive": { "type": "boolean" } } }, "UpdateProfileRequest": { "required": [ "displayName", "recoveryEmail" ], "type": "object", "properties": { "displayName": { "type": "string" }, "recoveryEmail": { "type": [ "null", "string" ] } } }, "UpdateQuotaRequest": { "required": [ "quotaBytes" ], "type": "object", "properties": { "quotaBytes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } } }, "UpdateRoleRequest": { "required": [ "role" ], "type": "object", "properties": { "role": { "type": "string" } } }, "UpdateSettingsRequest": { "required": [ "mailboxId", "displayName", "signatureHtml", "isAutoResponderEnabled", "autoResponderSubject", "autoResponderMessage", "recoveryEmail" ], "type": "object", "properties": { "mailboxId": { "type": [ "null", "string" ], "format": "uuid" }, "displayName": { "type": [ "null", "string" ] }, "signatureHtml": { "type": [ "null", "string" ] }, "isAutoResponderEnabled": { "type": [ "null", "boolean" ] }, "autoResponderSubject": { "type": [ "null", "string" ] }, "autoResponderMessage": { "type": [ "null", "string" ] }, "recoveryEmail": { "type": [ "null", "string" ] } } }, "UpdateSheetMetaRequest": { "required": [ "title", "isStarred", "isTrashed" ], "type": "object", "properties": { "title": { "type": [ "null", "string" ] }, "isStarred": { "type": [ "null", "boolean" ] }, "isTrashed": { "type": [ "null", "boolean" ] } } }, "UpdateStatusRequest": { "required": [ "status" ], "type": "object", "properties": { "status": { "type": "string" } } }, "UpdateTenantStatusRequest": { "required": [ "isActive", "reason" ], "type": "object", "properties": { "isActive": { "type": "boolean" }, "reason": { "type": [ "null", "string" ] } } }, "UpdateWebsiteControlsRequest": { "required": [ "announcementBannerEnabled", "announcementBannerText", "announcementBannerLink", "maintenanceMode", "maintenanceNotice", "allowNewRegistrations", "salesEmail", "salesPhone", "supportEmail" ], "type": "object", "properties": { "announcementBannerEnabled": { "type": "boolean" }, "announcementBannerText": { "type": [ "null", "string" ] }, "announcementBannerLink": { "type": [ "null", "string" ] }, "maintenanceMode": { "type": "boolean" }, "maintenanceNotice": { "type": [ "null", "string" ] }, "allowNewRegistrations": { "type": "boolean" }, "salesEmail": { "type": [ "null", "string" ] }, "salesPhone": { "type": [ "null", "string" ] }, "supportEmail": { "type": [ "null", "string" ] } } }, "UpgradePlanRequest": { "required": [ "organizationId", "planCode" ], "type": "object", "properties": { "organizationId": { "type": "string", "format": "uuid" }, "planCode": { "type": "string" }, "billingCycle": { "type": [ "null", "string" ], "default": "monthly" }, "seats": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 5 } } }, "VerifyEmailRequest": { "required": [ "email", "code" ], "type": "object", "properties": { "email": { "type": "string" }, "code": { "type": "string" } } }, "VerifyPaymentRequest": { "required": [ "organizationId", "razorpayOrderId", "razorpayPaymentId", "razorpaySignature" ], "type": "object", "properties": { "organizationId": { "type": "string", "format": "uuid" }, "razorpayOrderId": { "type": "string" }, "razorpayPaymentId": { "type": "string" }, "razorpaySignature": { "type": "string" } } }, "VerifyTrialSubscriptionRequest": { "required": [ "organizationId", "razorpaySubscriptionId", "razorpayPaymentId", "razorpaySignature" ], "type": "object", "properties": { "organizationId": { "type": "string", "format": "uuid" }, "razorpaySubscriptionId": { "type": "string" }, "razorpayPaymentId": { "type": "string" }, "razorpaySignature": { "type": "string" } } } } }, "tags": [ { "name": "lipiyo_backend" }, { "name": "Attachments" }, { "name": "Auth" }, { "name": "AuthSession" }, { "name": "BlogPublic" }, { "name": "Domains" }, { "name": "Inbound" }, { "name": "Mailboxes" }, { "name": "OrganizationMembers" }, { "name": "Payments" }, { "name": "Plans" }, { "name": "Audit" }, { "name": "Support" }, { "name": "Webmail" }, { "name": "Spreadsheets" }, { "name": "Files" }, { "name": "Folders" }, { "name": "Storage" }, { "name": "Documents" }, { "name": "BlogAdmin" }, { "name": "Deliverability" }, { "name": "Impersonation" }, { "name": "Inquiries" }, { "name": "Metrics" }, { "name": "PlansAdmin" }, { "name": "SystemInboxes" }, { "name": "Tenants" }, { "name": "WebsiteControls" } ] }