{ "openapi": "3.0.4", "info": { "title": "Skickamejl API", "description": "API surface for Skickamejl.", "version": "v1" }, "paths": { "/api/account/invitations": { "post": { "tags": [ "Account" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAccountInvitationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAccountInvitationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateAccountInvitationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreateAccountInvitationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateAccountInvitationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAccountInvitationResponse" } } } } } } }, "/api/account/users": { "get": { "tags": [ "Account" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountUsersResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountUsersResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountUsersResponse" } } } } } } }, "/account/billing/company-lookup": { "get": { "tags": [ "AccountBilling" ], "parameters": [ { "name": "organizationNumber", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScbCompanyLookupResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScbCompanyLookupResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScbCompanyLookupResult" } } } } } } }, "/api/campaigns": { "get": { "tags": [ "Campaigns" ], "parameters": [ { "name": "messageStream", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignResponse" } } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Campaigns" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCampaignRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CampaignResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CampaignResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CampaignResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/campaigns/{id}": { "get": { "tags": [ "Campaigns" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CampaignResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CampaignResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CampaignResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/campaigns/{id}/prepare": { "post": { "tags": [ "Campaigns" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CampaignPreparationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CampaignPreparationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CampaignPreparationResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/campaigns/{id}/send": { "post": { "tags": [ "Campaigns" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "202": { "description": "Accepted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CampaignActionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CampaignActionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CampaignActionResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/campaigns/{id}/resume": { "post": { "tags": [ "Campaigns" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "202": { "description": "Accepted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CampaignActionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CampaignActionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CampaignActionResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/campaigns/{id}/pause": { "post": { "tags": [ "Campaigns" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CampaignActionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CampaignActionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CampaignActionResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/campaigns/{id}/cancel": { "post": { "tags": [ "Campaigns" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CampaignActionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CampaignActionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CampaignActionResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/campaigns/{id}/recipients": { "get": { "tags": [ "Campaigns" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/BroadcastCampaignRecipientStatus" } }, { "name": "take", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 100 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignRecipientResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignRecipientResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignRecipientResponse" } } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/contact-lists": { "get": { "tags": [ "ContactLists" ], "parameters": [ { "name": "messageStream", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactListResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactListResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactListResponse" } } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "ContactLists" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateContactListRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ContactListResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContactListResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContactListResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/contact-lists/{id}/import": { "post": { "tags": [ "ContactLists" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportContactListRecipientsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ContactListImportResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContactListImportResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContactListImportResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/contact-lists/{id}/recipients": { "get": { "tags": [ "ContactLists" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ContactListRecipientStatus" } }, { "name": "take", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 100 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactListRecipientResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactListRecipientResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactListRecipientResponse" } } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/tools/deliverability/sessions": { "post": { "tags": [ "DeliverabilityTool" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeliverabilitySessionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeliverabilitySessionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeliverabilitySessionResponse" } } } } } } }, "/api/tools/deliverability/analyze": { "post": { "tags": [ "DeliverabilityTool" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliverabilityAnalyzeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeliverabilityAnalyzeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeliverabilityAnalyzeRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeliverabilityReportResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeliverabilityReportResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeliverabilityReportResponse" } } } } } } }, "/api/tools/deliverability/messages/{token}": { "post": { "tags": [ "DeliverabilityTool" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliverabilityAnalyzeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeliverabilityAnalyzeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeliverabilityAnalyzeRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeliverabilityReportResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeliverabilityReportResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeliverabilityReportResponse" } } } } } } }, "/api/development/billing-test/payments/latest/status": { "post": { "tags": [ "DevelopmentBillingTest" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DevelopmentPaymentStatusRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DevelopmentPaymentStatusRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DevelopmentPaymentStatusRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/development/billing-test/payments/latest": { "get": { "tags": [ "DevelopmentBillingTest" ], "responses": { "200": { "description": "OK" } } } }, "/api/development/billing-test/account": { "get": { "tags": [ "DevelopmentBillingTest" ], "responses": { "200": { "description": "OK" } } } }, "/api/development/billing-test/resources/seed": { "post": { "tags": [ "DevelopmentBillingTest" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DevelopmentResourceSeedRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DevelopmentResourceSeedRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DevelopmentResourceSeedRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/development/billing-test/resources": { "get": { "tags": [ "DevelopmentBillingTest" ], "responses": { "200": { "description": "OK" } } } }, "/api/development/billing-test/subscription/period-due": { "post": { "tags": [ "DevelopmentBillingTest" ], "responses": { "200": { "description": "OK" } } } }, "/api/development/billing-test/subscription/retry-due": { "post": { "tags": [ "DevelopmentBillingTest" ], "responses": { "200": { "description": "OK" } } } }, "/api/development/billing-test/jobs/monthly-billing": { "post": { "tags": [ "DevelopmentBillingTest" ], "responses": { "200": { "description": "OK" } } } }, "/api/tools/dkim/generate": { "post": { "tags": [ "DkimTool" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DkimGenerateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DkimGenerateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DkimGenerateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DkimGenerateResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DkimGenerateResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DkimGenerateResponse" } } } } } } }, "/api/tools/dkim/validate": { "get": { "tags": [ "DkimTool" ], "parameters": [ { "name": "domain", "in": "query", "schema": { "type": "string" } }, { "name": "selector", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DkimValidateResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DkimValidateResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DkimValidateResponse" } } } } } } }, "/api/tools/dmarc/check": { "get": { "tags": [ "DmarcTool" ], "parameters": [ { "name": "domain", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DmarcCheckResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DmarcCheckResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DmarcCheckResponse" } } } } } } }, "/api/tools/dns/lookup": { "get": { "tags": [ "DnsTool" ], "parameters": [ { "name": "domain", "in": "query", "schema": { "type": "string" } }, { "name": "type", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DnsLookupResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DnsLookupResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DnsLookupResponse" } } } } } } }, "/api/tools/domain/whois": { "get": { "tags": [ "DomainInvestigationTool" ], "parameters": [ { "name": "domain", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WhoisLookupResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WhoisLookupResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WhoisLookupResponse" } } } } } } }, "/api/tools/domain/propagation": { "get": { "tags": [ "DomainInvestigationTool" ], "parameters": [ { "name": "domain", "in": "query", "schema": { "type": "string" } }, { "name": "type", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DnsPropagationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DnsPropagationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DnsPropagationResponse" } } } } } } }, "/api/tools/domain/blacklist": { "get": { "tags": [ "DomainInvestigationTool" ], "parameters": [ { "name": "ipAddress", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BlacklistLookupResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BlacklistLookupResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BlacklistLookupResponse" } } } } } } }, "/api/tools/domain/ip-reputation": { "get": { "tags": [ "DomainInvestigationTool" ], "parameters": [ { "name": "ipAddress", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IpReputationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IpReputationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IpReputationResponse" } } } } } } }, "/api/Jobs/heartbeat": { "post": { "tags": [ "Jobs" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EnqueueJobResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EnqueueJobResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EnqueueJobResponse" } } } } } } }, "/api/Jobs/recalculate-counters": { "post": { "tags": [ "Jobs" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EnqueueJobResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EnqueueJobResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EnqueueJobResponse" } } } } } } }, "/api/Jobs/sync-backend-status": { "post": { "tags": [ "Jobs" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EnqueueJobResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EnqueueJobResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EnqueueJobResponse" } } } } } } }, "/robots.txt": { "get": { "tags": [ "MachineReadable" ], "responses": { "200": { "description": "OK" } } } }, "/llms.txt": { "get": { "tags": [ "MachineReadable" ], "responses": { "200": { "description": "OK" } } } }, "/.well-known/security.txt": { "get": { "tags": [ "MachineReadable" ], "responses": { "200": { "description": "OK" } } } }, "/api/Messages": { "post": { "tags": [ "Messages" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendMessageRequest" } } } }, "responses": { "202": { "description": "Accepted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SendMessageResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SendMessageResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SendMessageResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "502": { "description": "Bad Gateway", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/mollie/payments/webhook": { "post": { "tags": [ "MollieWebhook" ], "responses": { "200": { "description": "OK" } } } }, "/api/tools/mx/lookup": { "get": { "tags": [ "MxTool" ], "parameters": [ { "name": "domain", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MxLookupResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MxLookupResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MxLookupResponse" } } } } } } }, "/sitemap.xml": { "get": { "tags": [ "Sitemap" ], "responses": { "200": { "description": "OK" } } } }, "/openapi.json": { "get": { "tags": [ "Skickamejl" ], "responses": { "200": { "description": "OK" } } } }, "/anvandarvillkor": { "get": { "tags": [ "Skickamejl" ], "responses": { "200": { "description": "OK" } } }, "head": { "tags": [ "Skickamejl" ], "responses": { "200": { "description": "OK" } } } }, "/anvandaravtal": { "get": { "tags": [ "Skickamejl" ], "responses": { "200": { "description": "OK" } } }, "head": { "tags": [ "Skickamejl" ], "responses": { "200": { "description": "OK" } } } }, "/personuppgiftsbitradesavtal": { "get": { "tags": [ "Skickamejl" ], "responses": { "200": { "description": "OK" } } }, "head": { "tags": [ "Skickamejl" ], "responses": { "200": { "description": "OK" } } } }, "/pub-avtal": { "get": { "tags": [ "Skickamejl" ], "responses": { "200": { "description": "OK" } } }, "head": { "tags": [ "Skickamejl" ], "responses": { "200": { "description": "OK" } } } }, "/underbitraden": { "get": { "tags": [ "Skickamejl" ], "responses": { "200": { "description": "OK" } } }, "head": { "tags": [ "Skickamejl" ], "responses": { "200": { "description": "OK" } } } }, "/verktyg/spf": { "get": { "tags": [ "Skickamejl" ], "responses": { "200": { "description": "OK" } } }, "head": { "tags": [ "Skickamejl" ], "responses": { "200": { "description": "OK" } } } }, "/verktyg/dkim": { "get": { "tags": [ "Skickamejl" ], "responses": { "200": { "description": "OK" } } }, "head": { "tags": [ "Skickamejl" ], "responses": { "200": { "description": "OK" } } } }, "/verktyg/dmarc": { "get": { "tags": [ "Skickamejl" ], "responses": { "200": { "description": "OK" } } }, "head": { "tags": [ "Skickamejl" ], "responses": { "200": { "description": "OK" } } } }, "/verktyg/mx": { "get": { "tags": [ "Skickamejl" ], "responses": { "200": { "description": "OK" } } }, "head": { "tags": [ "Skickamejl" ], "responses": { "200": { "description": "OK" } } } }, "/verktyg/dns": { "get": { "tags": [ "Skickamejl" ], "responses": { "200": { "description": "OK" } } }, "head": { "tags": [ "Skickamejl" ], "responses": { "200": { "description": "OK" } } } }, "/verktyg/deliverability": { "get": { "tags": [ "Skickamejl" ], "responses": { "200": { "description": "OK" } } }, "head": { "tags": [ "Skickamejl" ], "responses": { "200": { "description": "OK" } } } }, "/verktyg/smtp": { "get": { "tags": [ "Skickamejl" ], "responses": { "200": { "description": "OK" } } }, "head": { "tags": [ "Skickamejl" ], "responses": { "200": { "description": "OK" } } } }, "/api/tools/smtp/test": { "post": { "tags": [ "SmtpTool" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SmtpTestRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SmtpTestRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SmtpTestRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SmtpTestResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SmtpTestResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SmtpTestResponse" } } } } } } }, "/api/tools/smtp/tls-certificate": { "post": { "tags": [ "SmtpTool" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TlsCertificateCheckRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TlsCertificateCheckRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TlsCertificateCheckRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TlsCertificateCheckResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TlsCertificateCheckResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TlsCertificateCheckResponse" } } } } } } }, "/api/tools/spf/generate": { "post": { "tags": [ "SpfTool" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpfGenerateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SpfGenerateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SpfGenerateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SpfGenerateResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SpfGenerateResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SpfGenerateResponse" } } } } } } }, "/api/Status": { "get": { "tags": [ "Status" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StatusResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StatusResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StatusResponse" } } } } } } }, "/api/Status/server-health": { "get": { "tags": [ "Status" ], "responses": { "200": { "description": "OK" } } } }, "/api/servers/{serverId}/template-images": { "get": { "tags": [ "TemplateImages" ], "parameters": [ { "name": "serverId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "TemplateImages" ], "parameters": [ { "name": "serverId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "File": { "type": "string", "format": "binary" } } }, "encoding": { "File": { "style": "form" } } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/servers/{serverId}/template-images/{assetId}": { "delete": { "tags": [ "TemplateImages" ], "parameters": [ { "name": "serverId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "assetId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/template-assets/{assetId}/{fileName}": { "get": { "tags": [ "TemplateImages" ], "parameters": [ { "name": "assetId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fileName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Templates/{alias}/send": { "post": { "tags": [ "Templates" ], "parameters": [ { "name": "alias", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendTemplateMessageRequest" } } } }, "responses": { "202": { "description": "Accepted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SendMessageResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SendMessageResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SendMessageResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "502": { "description": "Bad Gateway", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/track/open/{messageId}.gif": { "get": { "tags": [ "Tracking" ], "parameters": [ { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "s", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/track/click/{messageId}": { "get": { "tags": [ "Tracking" ], "parameters": [ { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "s", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "AccountApiUser": { "type": "object", "properties": { "userId": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "role": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "twoFactorEnabled": { "type": "boolean" } }, "additionalProperties": false }, "AccountUsersResponse": { "type": "object", "properties": { "users": { "type": "array", "items": { "$ref": "#/components/schemas/AccountApiUser" }, "nullable": true } }, "additionalProperties": false }, "BlacklistLookupResponse": { "type": "object", "properties": { "ipAddress": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/BlacklistResult" }, "nullable": true }, "issues": { "type": "array", "items": { "$ref": "#/components/schemas/ToolIssue" }, "nullable": true } }, "additionalProperties": false }, "BlacklistResult": { "type": "object", "properties": { "listName": { "type": "string", "nullable": true }, "query": { "type": "string", "nullable": true }, "listed": { "type": "boolean" }, "responses": { "type": "array", "items": { "type": "string" }, "nullable": true }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BroadcastCampaignRecipientStatus": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8 ], "type": "integer", "format": "int32" }, "CampaignActionResponse": { "type": "object", "properties": { "campaignId": { "type": "string", "format": "uuid" }, "status": { "type": "string", "nullable": true }, "jobId": { "type": "string", "nullable": true }, "warnings": { "type": "array", "items": { "type": "string" }, "nullable": true }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CampaignPreparationResponse": { "type": "object", "properties": { "campaignId": { "type": "string", "format": "uuid" }, "status": { "type": "string", "nullable": true }, "addedRecipients": { "type": "integer", "format": "int32" }, "skippedExistingRecipients": { "type": "integer", "format": "int32" }, "skippedSuppressedRecipients": { "type": "integer", "format": "int32" }, "totalRecipients": { "type": "integer", "format": "int32" }, "pendingRecipients": { "type": "integer", "format": "int32" }, "suppressedRecipients": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CampaignRecipientResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "emailAddress": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "messageId": { "type": "string", "nullable": true }, "backendDeliveryId": { "type": "string", "nullable": true }, "lastError": { "type": "string", "nullable": true }, "queuedAtUtc": { "type": "string", "format": "date-time", "nullable": true }, "completedAtUtc": { "type": "string", "format": "date-time", "nullable": true }, "updatedAtUtc": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "CampaignResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "contactListId": { "type": "string", "format": "uuid" }, "emailTemplateId": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "nullable": true }, "subject": { "type": "string", "nullable": true }, "fromAddress": { "type": "string", "nullable": true }, "fromName": { "type": "string", "nullable": true }, "replyToAddress": { "type": "string", "nullable": true }, "previewText": { "type": "string", "nullable": true }, "segmentFilterJson": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "totalRecipients": { "type": "integer", "format": "int32" }, "pendingRecipients": { "type": "integer", "format": "int32" }, "queuedRecipients": { "type": "integer", "format": "int32" }, "submittedRecipients": { "type": "integer", "format": "int32" }, "deliveredRecipients": { "type": "integer", "format": "int32" }, "bouncedRecipients": { "type": "integer", "format": "int32" }, "failedRecipients": { "type": "integer", "format": "int32" }, "suppressedRecipients": { "type": "integer", "format": "int32" }, "skippedRecipients": { "type": "integer", "format": "int32" }, "openedRecipients": { "type": "integer", "format": "int32" }, "clickedRecipients": { "type": "integer", "format": "int32" }, "unsubscribedRecipients": { "type": "integer", "format": "int32" }, "scheduledForUtc": { "type": "string", "format": "date-time", "nullable": true }, "startedAtUtc": { "type": "string", "format": "date-time", "nullable": true }, "completedAtUtc": { "type": "string", "format": "date-time", "nullable": true }, "createdAtUtc": { "type": "string", "format": "date-time" }, "updatedAtUtc": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "ContactListImportResponse": { "type": "object", "properties": { "contactListId": { "type": "string", "format": "uuid" }, "parsedRows": { "type": "integer", "format": "int32" }, "importedRecipients": { "type": "integer", "format": "int32" }, "updatedRecipients": { "type": "integer", "format": "int32" }, "duplicateRecipients": { "type": "integer", "format": "int32" }, "invalidRecipients": { "type": "integer", "format": "int32" }, "recipientCount": { "type": "integer", "format": "int32" }, "activeRecipientCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ContactListRecipientResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "emailAddress": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "source": { "type": "string", "nullable": true }, "updatedAtUtc": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "ContactListRecipientStatus": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32" }, "ContactListResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "recipientCount": { "type": "integer", "format": "int32" }, "activeRecipientCount": { "type": "integer", "format": "int32" }, "unsubscribedRecipientCount": { "type": "integer", "format": "int32" }, "suppressedRecipientCount": { "type": "integer", "format": "int32" }, "invalidRecipientCount": { "type": "integer", "format": "int32" }, "createdAtUtc": { "type": "string", "format": "date-time" }, "updatedAtUtc": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "CreateAccountInvitationRequest": { "required": [ "email" ], "type": "object", "properties": { "email": { "minLength": 1, "type": "string", "format": "email" } }, "additionalProperties": false }, "CreateAccountInvitationResponse": { "type": "object", "properties": { "status": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "emailSent": { "type": "boolean" }, "developmentInviteUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateCampaignRequest": { "required": [ "contactListId", "fromAddress", "name" ], "type": "object", "properties": { "messageStream": { "maxLength": 120, "minLength": 0, "type": "string", "nullable": true }, "contactListId": { "type": "string", "format": "uuid" }, "emailTemplateId": { "type": "string", "format": "uuid", "nullable": true }, "templateAlias": { "maxLength": 120, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 160, "minLength": 0, "type": "string" }, "subject": { "maxLength": 998, "minLength": 0, "type": "string", "nullable": true }, "fromAddress": { "maxLength": 320, "minLength": 0, "type": "string", "format": "email" }, "fromName": { "maxLength": 160, "minLength": 0, "type": "string", "nullable": true }, "replyToAddress": { "maxLength": 320, "minLength": 0, "type": "string", "format": "email", "nullable": true }, "previewText": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "textBody": { "type": "string", "nullable": true }, "htmlBody": { "type": "string", "nullable": true }, "contentBlocksJson": { "type": "string", "nullable": true }, "segmentFilterJson": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateContactListRequest": { "required": [ "name" ], "type": "object", "properties": { "messageStream": { "maxLength": 120, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 120, "minLength": 0, "type": "string" }, "description": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "DeliverabilityAnalyzeRequest": { "type": "object", "properties": { "token": { "type": "string", "nullable": true }, "mailFrom": { "type": "string", "nullable": true }, "heloName": { "type": "string", "nullable": true }, "remoteIp": { "type": "string", "nullable": true }, "rawMessage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DeliverabilityCheck": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "details": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DeliverabilityReportResponse": { "type": "object", "properties": { "token": { "type": "string", "nullable": true }, "checks": { "type": "array", "items": { "$ref": "#/components/schemas/DeliverabilityCheck" }, "nullable": true }, "headers": { "type": "array", "items": { "$ref": "#/components/schemas/HeaderView" }, "nullable": true }, "recommendations": { "type": "array", "items": { "type": "string" }, "nullable": true }, "spamAssassinApproximation": { "type": "number", "format": "double" } }, "additionalProperties": false }, "DeliverabilitySessionResponse": { "type": "object", "properties": { "token": { "type": "string", "nullable": true }, "testEmailAddress": { "type": "string", "nullable": true }, "expiresAtUtc": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "DevelopmentPaymentStatusRequest": { "type": "object", "properties": { "status": { "type": "string", "nullable": true }, "paymentId": { "type": "string", "format": "uuid", "nullable": true }, "mollieCustomerId": { "type": "string", "nullable": true }, "mollieMandateId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DevelopmentResourceSeedRequest": { "type": "object", "properties": { "serverCount": { "type": "integer", "format": "int32" }, "senderDomainCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DkimGenerateRequest": { "type": "object", "properties": { "domain": { "type": "string", "nullable": true }, "selector": { "type": "string", "nullable": true }, "keySize": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DkimGenerateResponse": { "type": "object", "properties": { "selector": { "type": "string", "nullable": true }, "hostName": { "type": "string", "nullable": true }, "txtRecord": { "type": "string", "nullable": true }, "publicKeyPem": { "type": "string", "nullable": true }, "privateKeyPem": { "type": "string", "nullable": true }, "issues": { "type": "array", "items": { "$ref": "#/components/schemas/ToolIssue" }, "nullable": true } }, "additionalProperties": false }, "DkimValidateResponse": { "type": "object", "properties": { "hostName": { "type": "string", "nullable": true }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/DnsRecordResult" }, "nullable": true }, "issues": { "type": "array", "items": { "$ref": "#/components/schemas/ToolIssue" }, "nullable": true } }, "additionalProperties": false }, "DmarcCheckResponse": { "type": "object", "properties": { "domain": { "type": "string", "nullable": true }, "hostName": { "type": "string", "nullable": true }, "record": { "type": "string", "nullable": true }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/DmarcTagExplanation" }, "nullable": true }, "issues": { "type": "array", "items": { "$ref": "#/components/schemas/ToolIssue" }, "nullable": true }, "recommendations": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "DmarcTagExplanation": { "type": "object", "properties": { "tag": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "meaning": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DnsLookupResponse": { "type": "object", "properties": { "domain": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/DnsRecordResult" }, "nullable": true }, "issues": { "type": "array", "items": { "$ref": "#/components/schemas/ToolIssue" }, "nullable": true }, "fromCache": { "type": "boolean" } }, "additionalProperties": false }, "DnsPropagationResponse": { "type": "object", "properties": { "domain": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/DnsResolverResult" }, "nullable": true }, "issues": { "type": "array", "items": { "$ref": "#/components/schemas/ToolIssue" }, "nullable": true } }, "additionalProperties": false }, "DnsRecordResult": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "priority": { "type": "integer", "format": "int32", "nullable": true }, "ttl": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DnsResolverResult": { "type": "object", "properties": { "resolver": { "type": "string", "nullable": true }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/DnsRecordResult" }, "nullable": true }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EnqueueJobResponse": { "type": "object", "properties": { "jobId": { "type": "string", "nullable": true }, "jobName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "HeaderView": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ImportContactListRecipientsRequest": { "required": [ "recipients" ], "type": "object", "properties": { "recipients": { "maxLength": 1000000, "minLength": 0, "type": "string" }, "source": { "maxLength": 120, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "IpReputationResponse": { "type": "object", "properties": { "ipAddress": { "type": "string", "nullable": true }, "riskLevel": { "type": "string", "nullable": true }, "signals": { "type": "array", "items": { "$ref": "#/components/schemas/ToolKeyValue" }, "nullable": true }, "blacklists": { "type": "array", "items": { "$ref": "#/components/schemas/BlacklistResult" }, "nullable": true }, "issues": { "type": "array", "items": { "$ref": "#/components/schemas/ToolIssue" }, "nullable": true } }, "additionalProperties": false }, "MxLookupResponse": { "type": "object", "properties": { "domain": { "type": "string", "nullable": true }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/MxRecordView" }, "nullable": true }, "issues": { "type": "array", "items": { "$ref": "#/components/schemas/ToolIssue" }, "nullable": true } }, "additionalProperties": false }, "MxRecordView": { "type": "object", "properties": { "host": { "type": "string", "nullable": true }, "priority": { "type": "integer", "format": "int32" }, "ipAddresses": { "type": "array", "items": { "type": "string" }, "nullable": true }, "provider": { "type": "string", "nullable": true }, "ttl": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "ScbCompanyLookupResult": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "organizationNumber": { "type": "string", "nullable": true }, "companyName": { "type": "string", "nullable": true }, "addressLine": { "type": "string", "nullable": true }, "careOfAddress": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "countryCode": { "type": "string", "nullable": true }, "countryName": { "type": "string", "nullable": true }, "vatNumber": { "type": "string", "nullable": true }, "currency": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "source": { "type": "string", "nullable": true }, "isActive": { "type": "boolean", "nullable": true }, "advertisingOptOut": { "type": "boolean", "nullable": true }, "advertisingOptOutRawValue": { "type": "string", "nullable": true }, "warningMessage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SendMessageRequest": { "required": [ "from", "subject", "to" ], "type": "object", "properties": { "from": { "minLength": 1, "type": "string", "format": "email" }, "replyTo": { "type": "string", "format": "email", "nullable": true }, "to": { "minLength": 1, "type": "string", "format": "email" }, "subject": { "maxLength": 200, "minLength": 0, "type": "string" }, "textBody": { "maxLength": 10000, "minLength": 0, "type": "string", "nullable": true }, "htmlBody": { "maxLength": 20000, "minLength": 0, "type": "string", "nullable": true }, "messageStream": { "maxLength": 120, "minLength": 0, "type": "string", "nullable": true }, "tag": { "maxLength": 120, "minLength": 0, "type": "string", "nullable": true }, "trackOpens": { "type": "boolean", "nullable": true }, "trackLinks": { "maxLength": 32, "minLength": 0, "type": "string", "nullable": true }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "SendMessageResponse": { "type": "object", "properties": { "messageId": { "type": "string", "nullable": true }, "deliveryId": { "type": "string", "nullable": true }, "jobId": { "type": "string", "nullable": true }, "serverId": { "type": "string", "format": "uuid", "nullable": true }, "status": { "type": "string", "nullable": true }, "messageStream": { "type": "string", "nullable": true }, "queuedAtUtc": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "SendTemplateMessageRequest": { "required": [ "from", "to" ], "type": "object", "properties": { "from": { "minLength": 1, "type": "string", "format": "email" }, "senderName": { "maxLength": 120, "minLength": 0, "type": "string", "nullable": true }, "replyTo": { "type": "string", "format": "email", "nullable": true }, "to": { "minLength": 1, "type": "string", "format": "email" }, "variables": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "messageStream": { "maxLength": 120, "minLength": 0, "type": "string", "nullable": true }, "tag": { "maxLength": 120, "minLength": 0, "type": "string", "nullable": true }, "trackOpens": { "type": "boolean", "nullable": true }, "trackLinks": { "maxLength": 32, "minLength": 0, "type": "string", "nullable": true }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "SmtpConversationStep": { "type": "object", "properties": { "direction": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "elapsedMilliseconds": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "SmtpTestRequest": { "type": "object", "properties": { "host": { "type": "string", "nullable": true }, "port": { "type": "integer", "format": "int32" }, "useStartTls": { "type": "boolean" }, "useSsl": { "type": "boolean" }, "username": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "mailFrom": { "type": "string", "nullable": true }, "rcptTo": { "type": "string", "nullable": true }, "sendMessage": { "type": "boolean" } }, "additionalProperties": false }, "SmtpTestResponse": { "type": "object", "properties": { "steps": { "type": "array", "items": { "$ref": "#/components/schemas/SmtpConversationStep" }, "nullable": true }, "issues": { "type": "array", "items": { "$ref": "#/components/schemas/ToolIssue" }, "nullable": true }, "success": { "type": "boolean" } }, "additionalProperties": false }, "SpfGenerateRequest": { "type": "object", "properties": { "domain": { "type": "string", "nullable": true }, "includes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "ip4": { "type": "array", "items": { "type": "string" }, "nullable": true }, "ip6": { "type": "array", "items": { "type": "string" }, "nullable": true }, "allMechanism": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SpfGenerateResponse": { "type": "object", "properties": { "record": { "type": "string", "nullable": true }, "characterLength": { "type": "integer", "format": "int32" }, "dnsLookupCount": { "type": "integer", "format": "int32" }, "issues": { "type": "array", "items": { "$ref": "#/components/schemas/ToolIssue" }, "nullable": true } }, "additionalProperties": false }, "StatusResponse": { "type": "object", "properties": { "application": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "timestampUtc": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "TlsCertificateCheckRequest": { "type": "object", "properties": { "host": { "type": "string", "nullable": true }, "port": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "TlsCertificateCheckResponse": { "type": "object", "properties": { "host": { "type": "string", "nullable": true }, "port": { "type": "integer", "format": "int32" }, "subject": { "type": "string", "nullable": true }, "issuer": { "type": "string", "nullable": true }, "notBeforeUtc": { "type": "string", "format": "date-time" }, "notAfterUtc": { "type": "string", "format": "date-time" }, "subjectAlternativeNames": { "type": "array", "items": { "type": "string" }, "nullable": true }, "protocol": { "type": "string", "nullable": true }, "cipher": { "type": "string", "nullable": true }, "issues": { "type": "array", "items": { "$ref": "#/components/schemas/ToolIssue" }, "nullable": true }, "success": { "type": "boolean" } }, "additionalProperties": false }, "ToolIssue": { "type": "object", "properties": { "severity": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ToolKeyValue": { "type": "object", "properties": { "label": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ValidationProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true } }, "additionalProperties": { } }, "WhoisLookupResponse": { "type": "object", "properties": { "domain": { "type": "string", "nullable": true }, "registrar": { "type": "string", "nullable": true }, "registryDomainId": { "type": "string", "nullable": true }, "statuses": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nameservers": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dates": { "type": "array", "items": { "$ref": "#/components/schemas/ToolKeyValue" }, "nullable": true }, "issues": { "type": "array", "items": { "$ref": "#/components/schemas/ToolIssue" }, "nullable": true } }, "additionalProperties": false } } }, "tags": [ { "name": "Account" }, { "name": "AccountBilling" }, { "name": "Campaigns" }, { "name": "ContactLists" }, { "name": "DeliverabilityTool" }, { "name": "DevelopmentBillingTest" }, { "name": "DkimTool" }, { "name": "DmarcTool" }, { "name": "DnsTool" }, { "name": "DomainInvestigationTool" }, { "name": "Jobs" }, { "name": "MachineReadable" }, { "name": "Messages" }, { "name": "MollieWebhook" }, { "name": "MxTool" }, { "name": "Sitemap" }, { "name": "Skickamejl" }, { "name": "SmtpTool" }, { "name": "SpfTool" }, { "name": "Status" }, { "name": "TemplateImages" }, { "name": "Templates" }, { "name": "Tracking" } ] }