{ "openapi": "3.0.1", "info": { "title": "MailMaks Public API", "description": "Makine-makine entegrasyon uçları (/mail/api/public/v1). Kimlik doğrulama: Authorization: Bearer mm_live_... veya X-Api-Key.", "version": "v1" }, "paths": { "/mail/api/public/v1/me": { "get": { "tags": [ "PublicAccount" ], "responses": { "200": { "description": "OK" } } } }, "/mail/api/public/v1/balance": { "get": { "tags": [ "PublicAccount" ], "responses": { "200": { "description": "OK" } } } }, "/mail/api/public/v1/credits/history": { "get": { "tags": [ "PublicAccount" ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "description": "OK" } } } }, "/mail/api/public/v1/identities": { "get": { "tags": [ "PublicAccount" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "PublicIdentities" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateIdentityRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateIdentityRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateIdentityRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/mail/api/public/v1/recipients/{email}/history": { "get": { "tags": [ "PublicAccount" ], "parameters": [ { "name": "email", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/mail/api/public/v1/campaigns": { "post": { "tags": [ "PublicCampaigns" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicCreateCampaignRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PublicCreateCampaignRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PublicCreateCampaignRequest" } } } }, "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "PublicCampaigns" ], "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "description": "OK" } } } }, "/mail/api/public/v1/campaigns/{id}": { "get": { "tags": [ "PublicCampaigns" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/mail/api/public/v1/campaigns/{id}/report": { "get": { "tags": [ "PublicCampaigns" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK" } } } }, "/mail/api/public/v1/campaigns/{id}/report/summary": { "get": { "tags": [ "PublicCampaigns" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/mail/api/public/v1/campaigns/{id}/report/funnel": { "get": { "tags": [ "PublicCampaigns" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/mail/api/public/v1/campaigns/{id}/recipients": { "get": { "tags": [ "PublicCampaigns" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/mail/api/public/v1/campaigns/{id}/recipients/export": { "get": { "tags": [ "PublicCampaigns" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "format", "in": "query", "schema": { "type": "string", "default": "csv" } } ], "responses": { "200": { "description": "OK" } } } }, "/mail/api/public/v1/campaigns/{id}/cancel": { "post": { "tags": [ "PublicCampaigns" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/mail/api/public/v1/campaigns/{id}/pause": { "post": { "tags": [ "PublicCampaigns" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/mail/api/public/v1/campaigns/{id}/resume": { "post": { "tags": [ "PublicCampaigns" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/mail/api/public/v1/campaigns/{id}/resend-to-unopened": { "post": { "tags": [ "PublicCampaigns" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResendToUnopenedRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResendToUnopenedRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ResendToUnopenedRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/mail/api/public/v1/events": { "get": { "tags": [ "PublicEvents" ], "parameters": [ { "name": "after", "in": "query", "schema": { "type": "string" } }, { "name": "types", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/mail/api/public/v1/identities/{id}": { "delete": { "tags": [ "PublicIdentities" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/mail/api/public/v1/identities/{id}/dns-records": { "get": { "tags": [ "PublicIdentities" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/mail/api/public/v1/identities/{id}/verify": { "post": { "tags": [ "PublicIdentities" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/mail/api/public/v1/messages": { "post": { "tags": [ "PublicMessages" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicSendMessageRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PublicSendMessageRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PublicSendMessageRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/mail/api/public/v1/messages/{id}": { "get": { "tags": [ "PublicMessages" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/mail/api/public/v1/messages/test": { "post": { "tags": [ "PublicMessages" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicTestSendRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PublicTestSendRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PublicTestSendRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/mail/api/public/v1/reputation": { "get": { "tags": [ "PublicReputation" ], "responses": { "200": { "description": "OK" } } } }, "/mail/api/public/v1/suppressions": { "get": { "tags": [ "PublicSuppressions" ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "customerRef", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "PublicSuppressions" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicAddSuppressionsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PublicAddSuppressionsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PublicAddSuppressionsRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/mail/api/public/v1/suppressions/{id}": { "delete": { "tags": [ "PublicSuppressions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/mail/api/public/v1/templates": { "get": { "tags": [ "PublicTemplates" ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "search", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "PublicTemplates" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTemplateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateTemplateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateTemplateRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/mail/api/public/v1/templates/{id}": { "get": { "tags": [ "PublicTemplates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "PublicTemplates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTemplateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateTemplateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateTemplateRequest" } } } }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "PublicTemplates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/mail/api/public/v1/templates/{id}/render-preview": { "post": { "tags": [ "PublicTemplates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenderPreviewRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RenderPreviewRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RenderPreviewRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/mail/api/public/v1/templates/{id}/send-test": { "post": { "tags": [ "PublicTemplates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateSendTestRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TemplateSendTestRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TemplateSendTestRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/mail/api/public/v1/uploads": { "post": { "tags": [ "PublicUploads" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "responses": { "200": { "description": "OK" } } } }, "/mail/api/public/v1/webhooks": { "post": { "tags": [ "PublicWebhooks" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWebhookRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateWebhookRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateWebhookRequest" } } } }, "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "PublicWebhooks" ], "responses": { "200": { "description": "OK" } } } }, "/mail/api/public/v1/webhooks/{id}": { "get": { "tags": [ "PublicWebhooks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "PublicWebhooks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWebhookRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateWebhookRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateWebhookRequest" } } } }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "PublicWebhooks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/mail/api/public/v1/webhooks/{id}/rotate-secret": { "post": { "tags": [ "PublicWebhooks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/mail/api/public/v1/webhooks/{id}/test": { "post": { "tags": [ "PublicWebhooks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "CreateIdentityRequest": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateTemplateRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "subject": { "type": "string", "nullable": true }, "html": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateWebhookRequest": { "type": "object", "properties": { "url": { "type": "string", "nullable": true }, "eventTypes": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "PublicAddSuppressionsRequest": { "type": "object", "properties": { "emails": { "type": "array", "items": { "type": "string" }, "nullable": true }, "scope": { "type": "string", "nullable": true }, "customerRef": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PublicAttachmentRefDto": { "type": "object", "properties": { "uploadId": { "type": "string", "nullable": true }, "fileName": { "type": "string", "nullable": true }, "size": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "PublicCreateCampaignRequest": { "type": "object", "properties": { "from": { "type": "string", "nullable": true }, "subject": { "type": "string", "nullable": true }, "html": { "type": "string", "nullable": true }, "recipients": { "type": "array", "items": { "type": "string" }, "nullable": true }, "scheduledAt": { "type": "string", "nullable": true }, "audience": { "type": "string", "nullable": true }, "customerRef": { "type": "string", "nullable": true }, "replyTo": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PublicSendMessageRequest": { "type": "object", "properties": { "from": { "type": "string", "nullable": true }, "to": { "type": "array", "items": { "type": "string" }, "nullable": true }, "cc": { "type": "array", "items": { "type": "string" }, "nullable": true }, "bcc": { "type": "array", "items": { "type": "string" }, "nullable": true }, "subject": { "type": "string", "nullable": true }, "html": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true }, "variables": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "scheduledAt": { "type": "string", "nullable": true }, "customerRef": { "type": "string", "nullable": true }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/PublicAttachmentRefDto" }, "nullable": true }, "replyTo": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PublicTestSendRequest": { "type": "object", "properties": { "from": { "type": "string", "nullable": true }, "to": { "type": "string", "nullable": true }, "subject": { "type": "string", "nullable": true }, "html": { "type": "string", "nullable": true }, "replyTo": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RenderPreviewRequest": { "type": "object", "properties": { "variables": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true } }, "additionalProperties": false }, "ResendToUnopenedRequest": { "type": "object", "properties": { "subject": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TemplateSendTestRequest": { "type": "object", "properties": { "identityId": { "type": "string", "nullable": true }, "recipient": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateTemplateRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "subject": { "type": "string", "nullable": true }, "html": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateWebhookRequest": { "type": "object", "properties": { "url": { "type": "string", "nullable": true }, "eventTypes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "http", "description": "Please enter a valid token", "scheme": "Bearer", "bearerFormat": "JWT" } } }, "security": [ { "Bearer": [ ] } ] }