{ "openapi": "3.1.0", "info": { "title": "Mailcore Management API", "version": "1.0.0", "description": "Customer account administration with explicit resource scopes and current-role authorization. Sending credentials, browser login, bank card/OTP authorization and operator controls are separate flows." }, "servers": [ { "url": "https://mailcore.uz" } ], "paths": { "/api/management/v1": { "get": { "operationId": "discovery", "summary": "Discover available management operations", "tags": [ "discovery" ], "security": [ { "managementBearer": [] } ], "parameters": [], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementTokenVerification" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } } } }, "/api/management/v1/token/verify": { "get": { "operationId": "token_verify", "summary": "Verify this credential and inspect its effective policy", "tags": [ "discovery" ], "security": [ { "managementBearer": [] } ], "parameters": [], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementTokenVerification" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } } } }, "/api/management/v1/account": { "get": { "operationId": "account", "summary": "Account", "tags": [ "account" ], "security": [ { "managementBearer": [] } ], "parameters": [], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `account.read`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "account.read" } }, "/api/management/v1/organizations": { "get": { "operationId": "organizations", "summary": "Organizations", "tags": [ "organizations" ], "security": [ { "managementBearer": [] } ], "parameters": [], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `organizations.read`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "organizations.read" }, "post": { "operationId": "organization_create", "summary": "Organization create", "tags": [ "organizations" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A new unique value per intentional mutation; reuse it only to retry the same request.", "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "example": "018f40d1-ff04-77cf-ae39-f18494cf8501" } ], "responses": { "201": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `organizations.write`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "organizations.write", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationCreateRequest" } } } } } }, "/api/management/v1/organizations/{organization_id}": { "get": { "operationId": "organization", "summary": "Organization", "tags": [ "organizations" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `organizations.read`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "organizations.read" } }, "/api/management/v1/organizations/{organization_id}/team": { "get": { "operationId": "team", "summary": "Team", "tags": [ "team" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `team.read`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "team.read" } }, "/api/management/v1/organizations/{organization_id}/team/invitations": { "post": { "operationId": "team_invite", "summary": "Team invite", "tags": [ "team" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A new unique value per intentional mutation; reuse it only to retry the same request.", "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "example": "018f40d1-ff04-77cf-ae39-f18494cf8501" } ], "responses": { "201": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `team.write`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "team.write", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamInviteRequest" } } } } } }, "/api/management/v1/organizations/{organization_id}/team/members/{account_id}": { "post": { "operationId": "team_member", "summary": "Team member", "tags": [ "team" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A new unique value per intentional mutation; reuse it only to retry the same request.", "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "example": "018f40d1-ff04-77cf-ae39-f18494cf8501" } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `team.write`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "team.write", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamMemberRequest" } } } } } }, "/api/management/v1/organizations/{organization_id}/team/invitations/{invitation_id}/revoke": { "post": { "operationId": "team_revoke", "summary": "Team revoke", "tags": [ "team" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "invitation_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A new unique value per intentional mutation; reuse it only to retry the same request.", "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "example": "018f40d1-ff04-77cf-ae39-f18494cf8501" } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `team.write`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "team.write", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmptyRequest" } } } } } }, "/api/management/v1/organizations/{organization_id}/team/invitations/{invitation_id}/resend": { "post": { "operationId": "team_resend", "summary": "Team resend", "tags": [ "team" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "invitation_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A new unique value per intentional mutation; reuse it only to retry the same request.", "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "example": "018f40d1-ff04-77cf-ae39-f18494cf8501" } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `team.write`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "team.write", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmptyRequest" } } } } } }, "/api/management/v1/account/invitations": { "get": { "operationId": "invitations", "summary": "Invitations", "tags": [ "account" ], "security": [ { "managementBearer": [] } ], "parameters": [], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `account.read`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "account.read" } }, "/api/management/v1/account/invitations/{invitation_id}/accept": { "post": { "operationId": "invitation_accept", "summary": "Invitation accept", "tags": [ "account" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "invitation_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A new unique value per intentional mutation; reuse it only to retry the same request.", "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "example": "018f40d1-ff04-77cf-ae39-f18494cf8501" } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `account.write`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "account.write", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmptyRequest" } } } } } }, "/api/management/v1/organizations/{organization_id}/domains": { "get": { "operationId": "domains", "summary": "Domains", "tags": [ "domains" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `domains.read`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "domains.read" }, "post": { "operationId": "domain_create", "summary": "Domain create", "tags": [ "domains" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A new unique value per intentional mutation; reuse it only to retry the same request.", "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "example": "018f40d1-ff04-77cf-ae39-f18494cf8501" } ], "responses": { "201": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `domains.write`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "domains.write", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountDomainCreateRequest" } } } } } }, "/api/management/v1/organizations/{organization_id}/domains/{domain_id}": { "get": { "operationId": "domain", "summary": "Domain", "tags": [ "domains" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `domains.read`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "domains.read" } }, "/api/management/v1/organizations/{organization_id}/domains/{domain_id}/services": { "post": { "operationId": "domain_services", "summary": "Domain services", "tags": [ "domains" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A new unique value per intentional mutation; reuse it only to retry the same request.", "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "example": "018f40d1-ff04-77cf-ae39-f18494cf8501" } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `domains.write`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "domains.write", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainServiceConfigureRequest" } } } } } }, "/api/management/v1/organizations/{organization_id}/domains/{domain_id}/mail-readiness/check": { "post": { "operationId": "domain_readiness", "summary": "Domain readiness", "tags": [ "domains" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A new unique value per intentional mutation; reuse it only to retry the same request.", "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "example": "018f40d1-ff04-77cf-ae39-f18494cf8501" } ], "responses": { "202": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `domains.write`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "domains.write", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmptyRequest" } } } } } }, "/api/management/v1/organizations/{organization_id}/domains/{domain_id}/orders/{order_id}/ownership/renew": { "post": { "operationId": "ownership_renew", "summary": "Ownership renew", "tags": [ "domains" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "order_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A new unique value per intentional mutation; reuse it only to retry the same request.", "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "example": "018f40d1-ff04-77cf-ae39-f18494cf8501" } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `domains.write`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "domains.write", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmptyRequest" } } } } } }, "/api/management/v1/organizations/{organization_id}/domains/{domain_id}/orders/{order_id}": { "get": { "operationId": "order", "summary": "Order", "tags": [ "domains" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "order_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `domains.read`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "domains.read" } }, "/api/management/v1/organizations/{organization_id}/domains/{domain_id}/orders/{order_id}/ownership/verify": { "post": { "operationId": "ownership_verify", "summary": "Ownership verify", "tags": [ "domains" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "order_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A new unique value per intentional mutation; reuse it only to retry the same request.", "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "example": "018f40d1-ff04-77cf-ae39-f18494cf8501" } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `domains.write`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "domains.write", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmptyRequest" } } } } } }, "/api/management/v1/organizations/{organization_id}/domains/{domain_id}/orders/{order_id}/dns/setup-mode": { "post": { "operationId": "dns_mode", "summary": "Dns mode", "tags": [ "domains" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "order_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A new unique value per intentional mutation; reuse it only to retry the same request.", "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "example": "018f40d1-ff04-77cf-ae39-f18494cf8501" } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `domains.write`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "domains.write", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSSetupModeRequest" } } } } } }, "/api/management/v1/organizations/{organization_id}/domains/{domain_id}/orders/{order_id}/dns/domain-connect": { "post": { "operationId": "dns_connect", "summary": "Dns connect", "tags": [ "domains" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "order_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A new unique value per intentional mutation; reuse it only to retry the same request.", "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "example": "018f40d1-ff04-77cf-ae39-f18494cf8501" } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `domains.write`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "domains.write", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainConnectRequest" } } } } } }, "/api/management/v1/organizations/{organization_id}/domains/{domain_id}/orders/{order_id}/plan": { "post": { "operationId": "plan", "summary": "Plan", "tags": [ "billing" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "order_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A new unique value per intentional mutation; reuse it only to retry the same request.", "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "example": "018f40d1-ff04-77cf-ae39-f18494cf8501" } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `billing.write`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "billing.write", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanRequest" } } } } } }, "/api/management/v1/organizations/{organization_id}/domains/{domain_id}/orders/{order_id}/checkout": { "post": { "operationId": "checkout", "summary": "Checkout", "tags": [ "billing" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "order_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A new unique value per intentional mutation; reuse it only to retry the same request.", "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "example": "018f40d1-ff04-77cf-ae39-f18494cf8501" } ], "responses": { "201": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `billing.write`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "billing.write", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmptyRequest" } } } } } }, "/api/management/v1/organizations/{organization_id}/domains/{domain_id}/orders/{order_id}/provision": { "post": { "operationId": "provision", "summary": "Provision", "tags": [ "mailboxes" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "order_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A new unique value per intentional mutation; reuse it only to retry the same request.", "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "example": "018f40d1-ff04-77cf-ae39-f18494cf8501" } ], "responses": { "202": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `mailboxes.write`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "mailboxes.write", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProvisionRequestBody" } } } } } }, "/api/management/v1/organizations/{organization_id}/domains/{domain_id}/orders/{order_id}/provision/recover": { "post": { "operationId": "provision_recover", "summary": "Provision recover", "tags": [ "mailboxes" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "order_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A new unique value per intentional mutation; reuse it only to retry the same request.", "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "example": "018f40d1-ff04-77cf-ae39-f18494cf8501" } ], "responses": { "202": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `mailboxes.write`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "mailboxes.write", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProvisionRecoveryRequestBody" } } } } } }, "/api/management/v1/organizations/{organization_id}/domains/{domain_id}/orders/{order_id}/dns/verify": { "post": { "operationId": "dns_verify", "summary": "Dns verify", "tags": [ "domains" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "order_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A new unique value per intentional mutation; reuse it only to retry the same request.", "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "example": "018f40d1-ff04-77cf-ae39-f18494cf8501" } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `domains.write`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "domains.write", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmptyRequest" } } } } } }, "/api/management/v1/organizations/{organization_id}/domains/{domain_id}/mailboxes": { "get": { "operationId": "mailboxes", "summary": "Mailboxes", "tags": [ "mailboxes" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `mailboxes.read`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "mailboxes.read" }, "post": { "operationId": "mailbox_create", "summary": "Mailbox create", "tags": [ "mailboxes" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A new unique value per intentional mutation; reuse it only to retry the same request.", "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "example": "018f40d1-ff04-77cf-ae39-f18494cf8501" } ], "responses": { "202": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `mailboxes.write`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "mailboxes.write", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailboxCreateRequest" } } } } } }, "/api/management/v1/organizations/{organization_id}/domains/{domain_id}/mailboxes/{mailbox_id}/suspend": { "post": { "operationId": "mailbox_suspend", "summary": "Mailbox suspend", "tags": [ "mailboxes" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "mailbox_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A new unique value per intentional mutation; reuse it only to retry the same request.", "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "example": "018f40d1-ff04-77cf-ae39-f18494cf8501" } ], "responses": { "202": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `mailboxes.write`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "mailboxes.write", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmptyRequest" } } } } } }, "/api/management/v1/organizations/{organization_id}/domains/{domain_id}/mailboxes/{mailbox_id}/resume": { "post": { "operationId": "mailbox_resume", "summary": "Mailbox resume", "tags": [ "mailboxes" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "mailbox_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A new unique value per intentional mutation; reuse it only to retry the same request.", "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "example": "018f40d1-ff04-77cf-ae39-f18494cf8501" } ], "responses": { "202": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `mailboxes.write`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "mailboxes.write", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmptyRequest" } } } } } }, "/api/management/v1/organizations/{organization_id}/domains/{domain_id}/mailboxes/{mailbox_id}/password-resets": { "post": { "operationId": "mailbox_password", "summary": "Mailbox password", "tags": [ "mailboxes" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "mailbox_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A new unique value per intentional mutation; reuse it only to retry the same request.", "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "example": "018f40d1-ff04-77cf-ae39-f18494cf8501" } ], "responses": { "202": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `mailboxes.write`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "mailboxes.write", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailboxPasswordResetRequest" } } } } } }, "/api/management/v1/organizations/{organization_id}/domains/{domain_id}/aliases": { "get": { "operationId": "aliases", "summary": "Aliases", "tags": [ "aliases" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `aliases.read`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "aliases.read" }, "post": { "operationId": "alias_create", "summary": "Alias create", "tags": [ "aliases" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A new unique value per intentional mutation; reuse it only to retry the same request.", "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "example": "018f40d1-ff04-77cf-ae39-f18494cf8501" } ], "responses": { "202": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `aliases.write`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "aliases.write", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AliasCreateRequest" } } } } } }, "/api/management/v1/organizations/{organization_id}/domains/{domain_id}/aliases/{alias_id}/retarget": { "post": { "operationId": "alias_retarget", "summary": "Alias retarget", "tags": [ "aliases" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "alias_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A new unique value per intentional mutation; reuse it only to retry the same request.", "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "example": "018f40d1-ff04-77cf-ae39-f18494cf8501" } ], "responses": { "202": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `aliases.write`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "aliases.write", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AliasRetargetRequest" } } } } } }, "/api/management/v1/organizations/{organization_id}/domains/{domain_id}/aliases/{alias_id}/offboard": { "post": { "operationId": "alias_offboard", "summary": "Alias offboard", "tags": [ "aliases" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "alias_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A new unique value per intentional mutation; reuse it only to retry the same request.", "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "example": "018f40d1-ff04-77cf-ae39-f18494cf8501" } ], "responses": { "202": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `aliases.write`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "aliases.write", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AliasOffboardRequest" } } } } } }, "/api/management/v1/organizations/{organization_id}/domains/{domain_id}/operations/{operation_id}/retry": { "post": { "operationId": "operation_retry", "summary": "Operation retry", "tags": [ "mailboxes" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "operation_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A new unique value per intentional mutation; reuse it only to retry the same request.", "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "example": "018f40d1-ff04-77cf-ae39-f18494cf8501" } ], "responses": { "202": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `mailboxes.write|aliases.write`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "mailboxes.write|aliases.write", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceOperationRetryRequest" } } } } } }, "/api/management/v1/organizations/{organization_id}/domains/{domain_id}/operations/{operation_id}": { "get": { "operationId": "operation", "summary": "Operation", "tags": [ "mailboxes" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "operation_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `mailboxes.read|aliases.read`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "mailboxes.read|aliases.read" } }, "/api/management/v1/organizations/{organization_id}/domains/{domain_id}/capacity-quote": { "get": { "operationId": "capacity_quote", "summary": "Capacity quote", "tags": [ "billing" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `billing.read`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "billing.read" } }, "/api/management/v1/organizations/{organization_id}/domains/{domain_id}/capacity-increases": { "post": { "operationId": "capacity_increase", "summary": "Capacity increase", "tags": [ "billing" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A new unique value per intentional mutation; reuse it only to retry the same request.", "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "example": "018f40d1-ff04-77cf-ae39-f18494cf8501" } ], "responses": { "202": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `billing.write`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "billing.write", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainCapacityIncreaseRequest" } } } } } }, "/api/management/v1/organizations/{organization_id}/domains/{domain_id}/capacity-increases/{change_id}": { "get": { "operationId": "capacity_status", "summary": "Capacity status", "tags": [ "billing" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "change_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `billing.read`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "billing.read" } }, "/api/management/v1/organizations/{organization_id}/domains/{domain_id}/storage-quote": { "get": { "operationId": "storage_quote", "summary": "Storage quote", "tags": [ "billing" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `billing.read`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "billing.read" } }, "/api/management/v1/organizations/{organization_id}/domains/{domain_id}/storage-increases": { "post": { "operationId": "storage_increase", "summary": "Storage increase", "tags": [ "billing" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A new unique value per intentional mutation; reuse it only to retry the same request.", "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "example": "018f40d1-ff04-77cf-ae39-f18494cf8501" } ], "responses": { "202": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `billing.write`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "billing.write", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainStorageIncreaseRequest" } } } } } }, "/api/management/v1/organizations/{organization_id}/domains/{domain_id}/storage-increases/{entitlement_id}": { "get": { "operationId": "storage_status", "summary": "Storage status", "tags": [ "billing" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "entitlement_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `billing.read`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "billing.read" } }, "/api/management/v1/organizations/{organization_id}/subscription": { "get": { "operationId": "subscription", "summary": "Subscription", "tags": [ "billing" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `billing.read`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "billing.read" } }, "/api/management/v1/organizations/{organization_id}/subscription/{subscription_id}/cancel": { "post": { "operationId": "subscription_cancel", "summary": "Subscription cancel", "tags": [ "billing" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "subscription_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A new unique value per intentional mutation; reuse it only to retry the same request.", "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "example": "018f40d1-ff04-77cf-ae39-f18494cf8501" } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `billing.write`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "billing.write", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmptyRequest" } } } } } }, "/api/management/v1/organizations/{organization_id}/subscription/{subscription_id}/resume": { "post": { "operationId": "subscription_resume", "summary": "Subscription resume", "tags": [ "billing" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "subscription_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A new unique value per intentional mutation; reuse it only to retry the same request.", "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "example": "018f40d1-ff04-77cf-ae39-f18494cf8501" } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `billing.write`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "billing.write", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmptyRequest" } } } } } }, "/api/management/v1/organizations/{organization_id}/subscription/card/authorize": { "post": { "operationId": "subscription_card_action", "summary": "Subscription card action", "tags": [ "billing" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A new unique value per intentional mutation; reuse it only to retry the same request.", "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "example": "018f40d1-ff04-77cf-ae39-f18494cf8501" } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `billing.write`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "billing.write", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmptyRequest" } } } } } }, "/api/management/v1/organizations/{organization_id}/invoices/{invoice_id}": { "get": { "operationId": "invoice", "summary": "Invoice", "tags": [ "billing" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "invoice_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `billing.read`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "billing.read" } }, "/api/management/v1/organizations/{organization_id}/invoices/{invoice_id}/checkout": { "post": { "operationId": "invoice_checkout", "summary": "Invoice checkout", "tags": [ "billing" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "invoice_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A new unique value per intentional mutation; reuse it only to retry the same request.", "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "example": "018f40d1-ff04-77cf-ae39-f18494cf8501" } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `billing.write`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "billing.write", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmptyRequest" } } } } } }, "/api/management/v1/organizations/{organization_id}/payment-attempts/{attempt_id}": { "get": { "operationId": "payment_attempt", "summary": "Payment attempt", "tags": [ "billing" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "attempt_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `billing.read`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "billing.read" } }, "/api/management/v1/organizations/{organization_id}/email-api": { "get": { "operationId": "email_overview", "summary": "Email overview", "tags": [ "email_projects" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `email_projects.read`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "email_projects.read" } }, "/api/management/v1/organizations/{organization_id}/email-api/billing": { "get": { "operationId": "email_billing", "summary": "Email billing", "tags": [ "billing" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `billing.read`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "billing.read" } }, "/api/management/v1/organizations/{organization_id}/email-api/checkouts": { "post": { "operationId": "email_checkout", "summary": "Email checkout", "tags": [ "billing" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A new unique value per intentional mutation; reuse it only to retry the same request.", "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "example": "018f40d1-ff04-77cf-ae39-f18494cf8501" } ], "responses": { "201": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `billing.write`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "billing.write", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PackageBody" } } } } } }, "/api/management/v1/organizations/{organization_id}/email-api/projects": { "post": { "operationId": "project_create", "summary": "Project create", "tags": [ "email_projects" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A new unique value per intentional mutation; reuse it only to retry the same request.", "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "example": "018f40d1-ff04-77cf-ae39-f18494cf8501" } ], "responses": { "201": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `email_projects.write`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "email_projects.write", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceBody" } } } } } }, "/api/management/v1/organizations/{organization_id}/email-api/projects/{project_id}": { "get": { "operationId": "project", "summary": "Project", "tags": [ "email_projects" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `email_projects.read`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "email_projects.read" } }, "/api/management/v1/organizations/{organization_id}/email-api/projects/{project_id}/check": { "post": { "operationId": "project_check", "summary": "Project check", "tags": [ "email_projects" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A new unique value per intentional mutation; reuse it only to retry the same request.", "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "example": "018f40d1-ff04-77cf-ae39-f18494cf8501" } ], "responses": { "202": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `email_projects.write`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "email_projects.write", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmptyRequest" } } } } } }, "/api/management/v1/organizations/{organization_id}/email-api/projects/{project_id}/marketing/enable": { "post": { "operationId": "project_marketing", "summary": "Project marketing", "tags": [ "email_projects" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A new unique value per intentional mutation; reuse it only to retry the same request.", "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "example": "018f40d1-ff04-77cf-ae39-f18494cf8501" } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `email_projects.write`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "email_projects.write", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketingBody" } } } } } }, "/api/management/v1/organizations/{organization_id}/email-api/projects/{project_id}/{stream}/keys": { "get": { "operationId": "email_keys", "summary": "Email keys", "tags": [ "email_keys" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "stream", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "transactional", "marketing" ] } } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `email_keys.read`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "email_keys.read" }, "post": { "operationId": "email_key_create", "summary": "Email key create", "tags": [ "email_keys" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "stream", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "transactional", "marketing" ] } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A new unique value per intentional mutation; reuse it only to retry the same request.", "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "example": "018f40d1-ff04-77cf-ae39-f18494cf8501" } ], "responses": { "201": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `email_keys.write`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "email_keys.write", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyBody" } } } } } }, "/api/management/v1/organizations/{organization_id}/email-api/projects/{project_id}/{stream}/keys/revoke": { "post": { "operationId": "email_key_revoke", "summary": "Email key revoke", "tags": [ "email_keys" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "stream", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "transactional", "marketing" ] } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A new unique value per intentional mutation; reuse it only to retry the same request.", "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "example": "018f40d1-ff04-77cf-ae39-f18494cf8501" } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `email_keys.write`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "email_keys.write", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokeBody" } } } } } }, "/api/management/v1/organizations/{organization_id}/email-api/projects/{project_id}/{stream}/webhooks": { "get": { "operationId": "webhooks", "summary": "Webhooks", "tags": [ "webhooks" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "stream", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "transactional", "marketing" ] } } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `webhooks.read`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "webhooks.read" }, "post": { "operationId": "webhook_create", "summary": "Webhook create", "tags": [ "webhooks" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "stream", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "transactional", "marketing" ] } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A new unique value per intentional mutation; reuse it only to retry the same request.", "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "example": "018f40d1-ff04-77cf-ae39-f18494cf8501" } ], "responses": { "201": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `webhooks.write`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "webhooks.write", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookBody" } } } } } }, "/api/management/v1/organizations/{organization_id}/email-api/projects/{project_id}/{stream}/webhooks/disable": { "post": { "operationId": "webhook_disable", "summary": "Webhook disable", "tags": [ "webhooks" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "stream", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "transactional", "marketing" ] } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A new unique value per intentional mutation; reuse it only to retry the same request.", "schema": { "type": "string", "minLength": 16, "maxLength": 128 }, "example": "018f40d1-ff04-77cf-ae39-f18494cf8501" } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `webhooks.write`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "webhooks.write", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookDisableBody" } } } } } }, "/api/management/v1/organizations/{organization_id}/email-api/projects/{project_id}/{stream}/activity/overview": { "get": { "operationId": "activity_overview", "summary": "Activity overview", "tags": [ "email_activity" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "stream", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "transactional", "marketing" ] } }, { "name": "period", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "24h", "7d", "30d" ] } }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "live", "test", "all" ] } }, { "name": "view", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "history", "queue" ] } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 48 } }, { "name": "query", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 254 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 1024 } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 50 } } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `email_activity.read`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "email_activity.read" } }, "/api/management/v1/organizations/{organization_id}/email-api/projects/{project_id}/{stream}/activity/messages": { "get": { "operationId": "activity_messages", "summary": "Activity messages", "tags": [ "email_activity" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "stream", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "transactional", "marketing" ] } }, { "name": "period", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "24h", "7d", "30d" ] } }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "live", "test", "all" ] } }, { "name": "view", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "history", "queue" ] } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 48 } }, { "name": "query", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 254 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 1024 } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 50 } } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `email_activity.read`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "email_activity.read" } }, "/api/management/v1/organizations/{organization_id}/email-api/projects/{project_id}/{stream}/activity/messages/{message_id}": { "get": { "operationId": "activity_message", "summary": "Activity message", "tags": [ "email_activity" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "stream", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "transactional", "marketing" ] } }, { "name": "message_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "period", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "24h", "7d", "30d" ] } }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "live", "test", "all" ] } }, { "name": "view", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "history", "queue" ] } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 48 } }, { "name": "query", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 254 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 1024 } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 50 } } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `email_activity.read`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "email_activity.read" } }, "/api/management/v1/organizations/{organization_id}/email-api/projects/{project_id}/{stream}/activity/batches": { "get": { "operationId": "activity_batches", "summary": "Activity batches", "tags": [ "email_activity" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "stream", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "transactional", "marketing" ] } }, { "name": "period", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "24h", "7d", "30d" ] } }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "live", "test", "all" ] } }, { "name": "view", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "history", "queue" ] } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 48 } }, { "name": "query", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 254 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 1024 } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 50 } } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `email_activity.read`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "email_activity.read" } }, "/api/management/v1/organizations/{organization_id}/email-api/projects/{project_id}/{stream}/activity/batches/{batch_id}": { "get": { "operationId": "activity_batch", "summary": "Activity batch", "tags": [ "email_activity" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "stream", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "transactional", "marketing" ] } }, { "name": "batch_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "period", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "24h", "7d", "30d" ] } }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "live", "test", "all" ] } }, { "name": "view", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "history", "queue" ] } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 48 } }, { "name": "query", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 254 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 1024 } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 50 } } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `email_activity.read`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "email_activity.read" } }, "/api/management/v1/organizations/{organization_id}/audit": { "get": { "operationId": "audit", "summary": "Audit", "tags": [ "audit" ], "security": [ { "managementBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "responses": { "200": { "description": "Successful resource, operation status or action required.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, invalid, revoked, expired or unavailable credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "403": { "description": "Permission, IP or current issuer authority does not allow this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "404": { "description": "Resource unavailable in this authorized scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "409": { "description": "Resource version, admission or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "422": { "description": "Invalid request fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "429": { "description": "Request admission limit; observe Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } }, "503": { "description": "Temporary dependency or capacity unavailability.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementError" } } } } }, "description": "Required permission: `audit.read`. Resource scope and the issuer’s current authority also apply.", "x-mailcore-permission": "audit.read" } } }, "components": { "securitySchemes": { "managementBearer": { "type": "http", "scheme": "bearer", "description": "One-time displayed mcm_ management token. Existing mck_ sending keys do not authenticate here." } }, "schemas": { "AccountDomainCreateRequest": { "additionalProperties": false, "properties": { "domain": { "maxLength": 2048, "minLength": 3, "title": "Domain", "type": "string" }, "inviteToken": { "anyOf": [ { "maxLength": 256, "minLength": 16, "type": "string" }, { "type": "null" } ], "default": null, "title": "Invitetoken" } }, "required": [ "domain" ], "title": "AccountDomainCreateRequest", "type": "object" }, "AliasCreateRequest": { "additionalProperties": false, "properties": { "localpart": { "maxLength": 64, "minLength": 1, "title": "Localpart", "type": "string" }, "destinationMailboxId": { "maxLength": 68, "minLength": 20, "title": "Destinationmailboxid", "type": "string" } }, "required": [ "localpart", "destinationMailboxId" ], "title": "AliasCreateRequest", "type": "object" }, "AliasOffboardRequest": { "additionalProperties": false, "properties": { "confirmation": { "maxLength": 254, "minLength": 3, "title": "Confirmation", "type": "string" } }, "required": [ "confirmation" ], "title": "AliasOffboardRequest", "type": "object" }, "AliasRetargetRequest": { "additionalProperties": false, "properties": { "destinationMailboxId": { "maxLength": 68, "minLength": 20, "title": "Destinationmailboxid", "type": "string" } }, "required": [ "destinationMailboxId" ], "title": "AliasRetargetRequest", "type": "object" }, "DNSSetupModeRequest": { "additionalProperties": false, "properties": { "mode": { "enum": [ "automatic", "manual" ], "title": "Mode", "type": "string" } }, "required": [ "mode" ], "title": "DNSSetupModeRequest", "type": "object" }, "DomainCapacityIncreaseRequest": { "additionalProperties": false, "properties": { "targetSeats": { "maximum": 100, "minimum": 1, "title": "Targetseats", "type": "integer" }, "expectedVersion": { "maxLength": 200, "minLength": 1, "title": "Expectedversion", "type": "string" } }, "required": [ "targetSeats", "expectedVersion" ], "title": "DomainCapacityIncreaseRequest", "type": "object" }, "DomainConnectRequest": { "additionalProperties": false, "properties": { "phase": { "enum": [ "ownership", "security", "cutover" ], "title": "Phase", "type": "string" }, "confirmMxCutover": { "default": false, "title": "Confirmmxcutover", "type": "boolean" } }, "required": [ "phase" ], "title": "DomainConnectRequest", "type": "object" }, "DomainServiceConfigureRequest": { "additionalProperties": false, "properties": { "product": { "enum": [ "corporate_mail", "email_api" ], "title": "Product", "type": "string" }, "enabled": { "title": "Enabled", "type": "boolean" } }, "required": [ "product", "enabled" ], "title": "DomainServiceConfigureRequest", "type": "object" }, "DomainStorageIncreaseRequest": { "additionalProperties": false, "properties": { "targetExtraStorageGb": { "maximum": 1000, "minimum": 0, "title": "Targetextrastoragegb", "type": "integer" }, "expectedVersion": { "maxLength": 200, "minLength": 1, "title": "Expectedversion", "type": "string" } }, "required": [ "targetExtraStorageGb", "expectedVersion" ], "title": "DomainStorageIncreaseRequest", "type": "object" }, "EmptyRequest": { "additionalProperties": false, "properties": {}, "title": "EmptyRequest", "type": "object" }, "KeyBody": { "additionalProperties": false, "properties": { "mode": { "enum": [ "live", "test" ], "title": "Mode", "type": "string" }, "name": { "maxLength": 80, "minLength": 1, "title": "Name", "type": "string" } }, "required": [ "mode", "name" ], "title": "KeyBody", "type": "object" }, "MailboxCreateRequest": { "additionalProperties": false, "properties": { "localpart": { "maxLength": 64, "minLength": 1, "title": "Localpart", "type": "string" }, "displayName": { "default": "", "maxLength": 160, "title": "Displayname", "type": "string" }, "temporaryPassword": { "format": "password", "maxLength": 128, "minLength": 16, "title": "Temporarypassword", "type": "string", "writeOnly": true } }, "required": [ "localpart", "temporaryPassword" ], "title": "MailboxCreateRequest", "type": "object" }, "MailboxPasswordResetRequest": { "additionalProperties": false, "properties": { "temporaryPassword": { "format": "password", "maxLength": 128, "minLength": 16, "title": "Temporarypassword", "type": "string", "writeOnly": true } }, "required": [ "temporaryPassword" ], "title": "MailboxPasswordResetRequest", "type": "object" }, "MarketingBody": { "additionalProperties": false, "properties": { "marketingDomain": { "maxLength": 253, "minLength": 3, "title": "Marketingdomain", "type": "string" }, "acceptSendingPolicy": { "const": true, "title": "Acceptsendingpolicy", "type": "boolean" } }, "required": [ "marketingDomain", "acceptSendingPolicy" ], "title": "MarketingBody", "type": "object" }, "OrganizationCreateRequest": { "additionalProperties": false, "properties": { "name": { "maxLength": 128, "minLength": 1, "title": "Name", "type": "string" } }, "required": [ "name" ], "title": "OrganizationCreateRequest", "type": "object" }, "PackageBody": { "additionalProperties": false, "properties": { "packageCode": { "maxLength": 40, "minLength": 1, "title": "Packagecode", "type": "string" } }, "required": [ "packageCode" ], "title": "PackageBody", "type": "object" }, "PlanRequest": { "additionalProperties": false, "properties": { "planCode": { "maxLength": 32, "minLength": 1, "title": "Plancode", "type": "string" }, "seats": { "maximum": 100, "minimum": 5, "title": "Seats", "type": "integer" }, "extraStorageGb": { "default": 0, "maximum": 1000, "minimum": 0, "title": "Extrastoragegb", "type": "integer" } }, "required": [ "planCode", "seats" ], "title": "PlanRequest", "type": "object" }, "ProvisionRecoveryRequestBody": { "additionalProperties": false, "properties": { "password": { "format": "password", "maxLength": 128, "minLength": 12, "title": "Password", "type": "string", "writeOnly": true } }, "required": [ "password" ], "title": "ProvisionRecoveryRequestBody", "type": "object" }, "ProvisionRequestBody": { "additionalProperties": false, "properties": { "localpart": { "maxLength": 64, "minLength": 1, "title": "Localpart", "type": "string" }, "password": { "format": "password", "maxLength": 128, "minLength": 12, "title": "Password", "type": "string", "writeOnly": true }, "displayName": { "default": "", "maxLength": 160, "title": "Displayname", "type": "string" } }, "required": [ "localpart", "password" ], "title": "ProvisionRequestBody", "type": "object" }, "ResourceOperationRetryRequest": { "additionalProperties": false, "properties": { "temporaryPassword": { "anyOf": [ { "format": "password", "maxLength": 128, "minLength": 16, "type": "string", "writeOnly": true }, { "type": "null" } ], "default": null, "title": "Temporarypassword" } }, "title": "ResourceOperationRetryRequest", "type": "object" }, "RevokeBody": { "additionalProperties": false, "properties": { "keyId": { "pattern": "^key_[a-f0-9]{24}$", "title": "Keyid", "type": "string" } }, "required": [ "keyId" ], "title": "RevokeBody", "type": "object" }, "TeamInviteRequest": { "additionalProperties": false, "properties": { "email": { "maxLength": 254, "minLength": 3, "title": "Email", "type": "string" }, "role": { "enum": [ "admin", "technical", "member" ], "title": "Role", "type": "string" } }, "required": [ "email", "role" ], "title": "TeamInviteRequest", "type": "object" }, "TeamMemberRequest": { "additionalProperties": false, "properties": { "role": { "enum": [ "admin", "technical", "member", "remove" ], "title": "Role", "type": "string" } }, "required": [ "role" ], "title": "TeamMemberRequest", "type": "object" }, "WebhookBody": { "additionalProperties": false, "properties": { "url": { "maxLength": 2048, "minLength": 8, "title": "Url", "type": "string" } }, "required": [ "url" ], "title": "WebhookBody", "type": "object" }, "WebhookDisableBody": { "additionalProperties": false, "properties": { "webhookId": { "pattern": "^wh_[a-f0-9]{24}$", "title": "Webhookid", "type": "string" } }, "required": [ "webhookId" ], "title": "WebhookDisableBody", "type": "object" }, "WorkspaceBody": { "additionalProperties": false, "properties": { "domain": { "maxLength": 253, "minLength": 3, "title": "Domain", "type": "string" }, "marketingDomain": { "default": "", "maxLength": 253, "title": "Marketingdomain", "type": "string" }, "senderLocalpart": { "default": "notifications", "maxLength": 64, "minLength": 1, "title": "Senderlocalpart", "type": "string" }, "acceptSendingPolicy": { "const": true, "title": "Acceptsendingpolicy", "type": "boolean" } }, "required": [ "domain", "acceptSendingPolicy" ], "title": "WorkspaceBody", "type": "object" }, "ManagementError": { "type": "object", "description": "Stable error code, safe message and request identifier.", "properties": { "ok": { "const": false }, "error": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "requestId": { "type": "string" } } }, "ManagementTokenVerification": { "type": "object", "description": "Current credential policy and authorized resources; bearer material is never returned.", "required": [ "ok", "tokenId", "accountId", "scope", "permissions", "resources", "expiresAt" ], "properties": { "ok": { "const": true }, "tokenId": { "type": "string" }, "accountId": { "type": "string" }, "scope": { "type": "object" }, "permissions": { "type": "array", "items": { "type": "object" } }, "resources": { "type": "array", "items": { "type": "object" } }, "expiresAt": { "type": [ "string", "null" ], "format": "date-time", "description": "UTC expiration timestamp, or null for an explicitly non-expiring token. Revocation, activation time, IP restrictions and current issuer authority still apply." } } } } } }