{ "openapi": "3.1.0", "info": { "title": "aevent", "version": "0.0.1" }, "servers": [ { "url": "https://app-api.aevent.com/api" } ], "tags": [ { "name": "Contact Hours" }, { "name": "Actions / MCP" }, { "name": "Header Script" } ], "paths": { "/actions": { "get": { "operationId": "actions.index", "tags": [ "Actions / MCP" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "array", "items": { "type": "string" } } }, "required": [ "success" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } }, "post": { "operationId": "actions.store", "tags": [ "Actions / MCP" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "action": { "$ref": "#/components/schemas/ActionType" } }, "required": [ "action" ] } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "string" } }, "required": [ "success" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/hours": { "get": { "operationId": "hours.index", "tags": [ "Contact Hours" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } }, "post": { "operationId": "hours.store", "tags": [ "Contact Hours" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" }, "retry": { "type": "boolean" }, "campaigns": { "type": "array", "items": { "type": "string" } }, "integrations": { "type": "array", "items": { "type": "string" } } }, "required": [ "start", "end", "retry" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/hours/{hour}": { "get": { "operationId": "hours.show", "tags": [ "Contact Hours" ], "parameters": [ { "name": "hour", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } }, "put": { "operationId": "hours.update", "tags": [ "Contact Hours" ], "parameters": [ { "name": "hour", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" }, "retry": { "type": "boolean" }, "campaigns": { "type": "array", "items": { "type": "string" } }, "integrations": { "type": "array", "items": { "type": "string" } } }, "required": [ "start", "end", "retry" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } }, "delete": { "operationId": "hours.destroy", "tags": [ "Contact Hours" ], "parameters": [ { "name": "hour", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/getdata": { "get": { "operationId": "auto.getNewScript", "summary": "Header script data for registration, confirmation, and replay pages", "tags": [ "Header Script" ], "parameters": [ { "name": "db", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "string" } }, { "name": "email", "in": "query", "schema": { "type": "string" } }, { "name": "value", "in": "query", "schema": { "type": "string" } }, { "name": "wtl", "in": "query", "required": true, "description": "Campaign ID.", "schema": { "type": "string" }, "example": "gkgNtHFNCUcpqax" }, { "name": "webinar", "in": "query", "description": "Webinar ID.", "schema": { "type": "string" }, "example": "3800002049" }, { "name": "systemTimezone", "in": "query", "description": "Browser time zone, used to generate correct time zone abbreviation when the registrant's browser does not have language support installed.", "schema": { "type": "string" }, "example": "America/Los_Angeles" }, { "name": "r", "in": "query", "description": "Registrant ID to fetch information for.", "schema": { "type": "string" }, "example": "JvcAndSNQbeg8Th6sFeAVQ" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "string" }, { "type": "object" } ] } } } }, "410": { "description": "An error\n\nAn error", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "No subscriber." } }, "required": [ "message" ] }, { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "" } }, "required": [ "message" ] } ] } } } }, "400": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "Campaign is archived." } }, "required": [ "message" ] } } } }, "500": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "" } }, "required": [ "message" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" } } } }, "/analytics/launch": { "post": { "operationId": "analytics.launch", "tags": [ "Analytics" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "webinarTimeline": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" } }, "required": [ "startDate", "endDate" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/analytics/attendance": { "post": { "operationId": "analytics.attendance", "summary": "Campaign analytics", "tags": [ "Analytics" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "webinarTimeline": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" } }, "required": [ "startDate", "endDate" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/analytics/breakdown": { "post": { "operationId": "analytics.breakdown", "summary": "Dashboard audience breakdown analytics", "tags": [ "Analytics" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "startDate": { "type": [ "string", "null" ] }, "endDate": { "type": [ "string", "null" ] }, "period": { "type": [ "string", "null" ], "enum": [ "daily", "weekly", "monthly", "yearly" ] } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/complete": { "post": { "operationId": "completion.create", "summary": "ChatGPT completion for frontend UI features", "tags": [ "Completion" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "integrationID": { "type": "string" }, "prompt": { "type": [ "string", "null" ] }, "systemPrompt": { "type": "string" }, "key": { "type": "string" }, "wtl": { "type": "string" } }, "required": [ "integrationID" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "410": { "description": "An error\n\nAn error\n\nAn error", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "The list of prompts that should be in the backoffice localizations does not exist." } }, "required": [ "message" ] }, { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "The specified system prompt could not be found." } }, "required": [ "message" ] }, { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "No integration with that ID." } }, "required": [ "message" ] } ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/next": { "get": { "operationId": "completion.next", "summary": "Account/campaign diagnostics", "tags": [ "Completion" ], "parameters": [ { "name": "wtl", "in": "query", "schema": { "type": [ "string", "null" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } }, "required": [ "success" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/media/create": { "post": { "operationId": "file.create", "tags": [ "File" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMediaRequest" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserFile" } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "403": { "$ref": "#/components/responses/AuthorizationException" } } } }, "/media/update": { "post": { "operationId": "file.update_0", "summary": "Used by UI to update files and by Media to update with the compressed url and transcoding status", "tags": [ "File" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateMediaRequest" }, { "type": "object", "properties": { "files": { "type": "string" }, "userId": { "type": "string" } } } ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "410": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "No files found." } }, "required": [ "message" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "403": { "$ref": "#/components/responses/AuthorizationException" } } }, "put": { "operationId": "updateFile", "summary": "Used by UI to update files and by Media to update with the compressed url and transcoding status", "tags": [ "File" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMediaRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "410": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "No files found." } }, "required": [ "message" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/media/alert": { "post": { "operationId": "encodingFailed", "summary": "DHCA / user notification alert callback for the Media project", "tags": [ "File" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "dbname": { "type": "string" }, "userId": { "type": "string" }, "fileId": { "type": "string" }, "exceptionType": { "type": "string" }, "message": { "type": "string" } }, "required": [ "dbname", "userId", "fileId", "exceptionType", "message" ] } } } }, "responses": { "200": { "description": "" }, "410": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "" } }, "required": [ "message" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" } } } }, "/media": { "put": { "operationId": "updateFiles", "summary": "Used by UI to update files and by Media to update with the compressed url and transcoding status", "tags": [ "File" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMediaRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "410": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "No files found." } }, "required": [ "message" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } }, "delete": { "operationId": "deleteManyFiles", "tags": [ "File" ], "parameters": [ { "name": "files", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": {} }, "required": [ "success" ] } } } }, "410": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "No files found." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" }, "403": { "$ref": "#/components/responses/AuthorizationException" } } } }, "/media/{file}": { "delete": { "operationId": "deleteFile", "tags": [ "File" ], "parameters": [ { "name": "file", "in": "path", "required": true, "description": "The file uniqueid", "schema": { "type": "integer" } }, { "name": "file", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "$ref": "#/components/schemas/UserFile" } }, "required": [ "success" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } } }, "/media/ajaxGetFiles/{type}": { "get": { "operationId": "file.ajaxGetFiles", "tags": [ "File" ], "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer" } }, { "name": "count", "in": "query", "schema": { "type": "integer" } }, { "name": "folder", "in": "query", "schema": { "type": "string" } }, { "name": "last", "in": "query", "schema": { "type": [ "integer", "null" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/media/renameFile": { "post": { "operationId": "file.renameFile", "tags": [ "File" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "image", "audio", "video", "folder" ] } }, "required": [ "id", "name", "type" ] } }, "required": [ "data" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/forms": { "get": { "operationId": "forms.index", "tags": [ "Form" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } }, "post": { "operationId": "forms.store", "tags": [ "Form" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFormRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" }, "403": { "$ref": "#/components/responses/AuthorizationException" } } } }, "/forms/{form}": { "get": { "operationId": "forms.show", "tags": [ "Form" ], "parameters": [ { "name": "form", "in": "path", "required": true, "description": "The form ID", "schema": { "type": "string", "format": "uuid" } }, { "name": "wtl", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "registration", "confirmation", "replay", "pixel" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } }, "put": { "operationId": "forms.update", "tags": [ "Form" ], "parameters": [ { "name": "form", "in": "path", "required": true, "description": "The form ID", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFormRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } }, "delete": { "operationId": "forms.destroy", "tags": [ "Form" ], "parameters": [ { "name": "form", "in": "path", "required": true, "description": "The form ID", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/holidays": { "get": { "operationId": "holidays.index", "tags": [ "Holiday" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } }, "post": { "operationId": "holidays.store", "tags": [ "Holiday" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } }, "required": [ "start", "end" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/holidays/{holiday}": { "get": { "operationId": "holidays.show", "tags": [ "Holiday" ], "parameters": [ { "name": "holiday", "in": "path", "required": true, "description": "The holiday ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } }, "put": { "operationId": "holidays.update", "tags": [ "Holiday" ], "parameters": [ { "name": "holiday", "in": "path", "required": true, "description": "The holiday ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } }, "required": [ "start", "end" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } }, "delete": { "operationId": "holidays.destroy", "tags": [ "Holiday" ], "parameters": [ { "name": "holiday", "in": "path", "required": true, "description": "The holiday ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/globalsetting/customfieldtype": { "post": { "operationId": "home.getCustomFieldType", "summary": "Get custom field type used in autoresponder setting", "tags": [ "Home" ], "responses": { "200": { "description": "$sRet = $this->getServerVariable(CACHE_SERVER_VARIABLE_CUSTOM_FIELD, json_encode($sRet), true);", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/globalsetting/personalize": { "post": { "operationId": "home.getPersonalizeFields", "summary": "Get personalization field from db", "tags": [ "Home" ], "responses": { "200": { "description": "$sRet = $this->getServerVariable(CACHE_SERVER_VARIABLE_PERSONALIZE, json_encode($sRet), true);", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/globalsetting/customfieldtemplate": { "post": { "operationId": "home.getCustomFieldTemplate", "summary": "Get custom field template", "tags": [ "Home" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/globalsetting/integration-description": { "post": { "operationId": "home.getIntegrationDescription", "summary": "Get integration description from db", "tags": [ "Home" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/globalsetting/tooltip": { "post": { "operationId": "home.getTooltip", "summary": "Get tooltip from db", "tags": [ "Home" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/globalsetting/language": { "post": { "operationId": "home.getLanguge", "summary": "Get Language", "tags": [ "Home" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/input": { "get": { "operationId": "input.index", "tags": [ "Input" ], "parameters": [ { "name": "type", "in": "query", "schema": { "type": [ "string", "null" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } }, "post": { "operationId": "input.store", "tags": [ "Input" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveInputRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" }, "403": { "$ref": "#/components/responses/AuthorizationException" } } } }, "/input/{input}": { "get": { "operationId": "input.show", "tags": [ "Input" ], "parameters": [ { "name": "input", "in": "path", "required": true, "description": "The input ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } }, "put": { "operationId": "input.update", "tags": [ "Input" ], "parameters": [ { "name": "input", "in": "path", "required": true, "description": "The input ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveInputRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" }, "403": { "$ref": "#/components/responses/AuthorizationException" } } }, "delete": { "operationId": "input.destroy", "tags": [ "Input" ], "parameters": [ { "name": "input", "in": "path", "required": true, "description": "The input ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/integration/create": { "post": { "operationId": "integration.createIntegration", "summary": "Create Integration", "tags": [ "Integration" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "blocks": { "type": "string", "minLength": 3 } }, "required": [ "blocks" ] } } } }, "responses": { "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "enum": [ "Error creating Webinar Integration" ] } }, "required": [ "error" ] } } } }, "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "prefixItems": [ { "type": "object", "properties": { "success": { "type": "string", "enum": [ "duplicated" ] } }, "required": [ "success" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false } ] } } } }, "400": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "" } }, "required": [ "message" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/integration/update": { "post": { "operationId": "integration.updateIntegration", "summary": "Update Integration", "tags": [ "Integration" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "blocks": { "type": "string", "minLength": 3 }, "integrationID": { "type": "string" } }, "required": [ "blocks", "integrationID" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "prefixItems": [ { "type": "object", "properties": { "success": { "type": "string", "enum": [ "duplicated" ] } }, "required": [ "success" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false }, { "type": "object", "properties": { "failure": { "type": "string", "enum": [ "Could not find integration with id." ] } }, "required": [ "failure" ] } ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" }, "403": { "$ref": "#/components/responses/AuthorizationException" } } } }, "/integration/delete": { "post": { "operationId": "integration.deleteIntegration", "summary": "Delete Integration", "tags": [ "Integration" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "integrationID": { "type": "string", "maxLength": 255 } }, "required": [ "integrationID" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/integration/adddata": { "post": { "operationId": "integration.addIntegrationData", "summary": "Add extra data to existing integration", "tags": [ "Integration" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "blocks": { "type": "string" }, "integrationID": { "type": "string" }, "type": { "type": "string", "default": "normal" } }, "required": [ "blocks", "integrationID" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "410": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "" } }, "required": [ "message" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/integration/used": { "post": { "operationId": "integration.isIntegrationUsed", "summary": "Check if integration is in use by any timeline", "tags": [ "Integration" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "integrationID": { "type": "string" } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/integration/get": { "post": { "operationId": "integration.getIntegration", "summary": "Get all integrations", "tags": [ "Integration" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/integration/search": { "post": { "operationId": "integration.searchIntegration", "summary": "Search Integration Data", "tags": [ "Integration" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "integrationID": { "type": "string" }, "nodeID": { "type": "string" }, "query": { "type": [ "string", "null" ] }, "page": { "type": [ "integer", "null" ] }, "count": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 50 } }, "required": [ "integrationID", "nodeID" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationData" } } }, "required": [ "success" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/integration/share": { "post": { "operationId": "integration.share", "summary": "Share an integration with a partner subaccount", "tags": [ "Integration" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userID": { "type": "integer" }, "share": { "type": "boolean" }, "integrationID": { "type": "array", "items": { "type": "string" } } }, "required": [ "userID" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] } } } }, "403": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "You must be the billing account to share an integration with partners." } }, "required": [ "message" ] } } } }, "410": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "The integration does not exist." } }, "required": [ "message" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/{type}/getlists": { "post": { "operationId": "integration.getIntegrationLists", "summary": "Refresh all fields of integration", "tags": [ "Integration" ], "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "integrationID": { "type": "string" } }, "required": [ "integrationID" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "429": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "This integration is already being refreshed; timed out waiting for the previous attempt to end." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/{type}/addfield": { "post": { "operationId": "integration.addIntegrationField", "summary": "Add Integration Field", "tags": [ "Integration" ], "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "integrationID": { "type": "string" }, "name": { "type": "string" }, "listID": { "type": "string" } }, "required": [ "integrationID", "name" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/{type}/addautofield": { "post": { "operationId": "integration.addIntegrationAutoField", "summary": "Automatically create predefined custom fields", "tags": [ "Integration" ], "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "integrationID": { "type": "string" }, "name": { "type": "string" }, "listID": { "type": "string" } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/{type}/check": { "post": { "operationId": "integration.checkIntegrationCredential", "summary": "Check Credentials for non OAuth2 Integrations when Creating & Updating", "tags": [ "Integration" ], "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/{type}/addtag": { "post": { "operationId": "integration.addIntegrationTag", "summary": "Add Integration Tag", "tags": [ "Integration" ], "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "integrationID": { "type": "string" }, "name": { "type": "string" }, "listID": { "type": "string" } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "410": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "" } }, "required": [ "message" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/tags": { "post": { "operationId": "integration.addBulkTag", "tags": [ "Integration" ], "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "string" } }, "required": [ "success" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/fbaudience/audience/create": { "post": { "operationId": "integration.createIntegrationFBAudience", "summary": "Create FBAudience", "tags": [ "Integration" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "integrationID": { "type": "string" }, "name": { "type": "string" }, "adAccountId": { "type": "string" } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/niftyimage/delete": { "post": { "operationId": "integration.deleteNiftyImageRequest", "summary": "Delete nifty image", "tags": [ "Integration" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "integrationID": { "type": "string" }, "url": { "type": "string" } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/niftyimage/bulk-delete": { "post": { "operationId": "integration.bulkDeleteNiftyImage", "tags": [ "Integration" ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "array", "items": { "type": "string", "format": "uri", "maxLength": 2048 } }, "minItems": 1 } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/{type}/addHeaderName": { "post": { "operationId": "integration.addHeaderName", "summary": "Add Google Sheet Header Name", "tags": [ "Integration" ], "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "integrationID": { "type": "string" }, "name": { "type": "string" } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/localization/{localizationKey}": { "get": { "operationId": "localization.show", "summary": "Translated locale strings", "tags": [ "Localization" ], "parameters": [ { "name": "localizationKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "content": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] } }, "required": [ "content" ] } } } } } } }, "/filters": { "get": { "operationId": "filters.index", "tags": [ "RegionalFilter" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "string" } }, "required": [ "success" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } }, "post": { "operationId": "filters.store", "tags": [ "RegionalFilter" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/LocationType" }, "location": { "type": "string", "minLength": 2, "maxLength": 191 } }, "required": [ "type", "location" ] } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "string" } }, "required": [ "success" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/filters/{filter}": { "get": { "operationId": "filters.show", "tags": [ "RegionalFilter" ], "parameters": [ { "name": "filter", "in": "path", "required": true, "description": "The filter ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "$ref": "#/components/schemas/RegionalFilter" } }, "required": [ "success" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } }, "put": { "operationId": "filters.update", "tags": [ "RegionalFilter" ], "parameters": [ { "name": "filter", "in": "path", "required": true, "description": "The filter ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/LocationType" }, "location": { "type": "string", "minLength": 2, "maxLength": 191 } }, "required": [ "type", "location" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "$ref": "#/components/schemas/RegionalFilter" } }, "required": [ "success" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } }, "delete": { "operationId": "filters.destroy", "tags": [ "RegionalFilter" ], "parameters": [ { "name": "filter", "in": "path", "required": true, "description": "The filter ID", "schema": { "type": "integer" } } ], "responses": { "204": { "description": "No content" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/registrants": { "get": { "operationId": "registrant.index", "tags": [ "Registrant" ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer" } }, { "name": "count", "in": "query", "schema": { "type": "integer" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "banned", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "true", "false" ] } }, { "name": "unsubscribed", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "true", "false" ] } }, { "name": "wtl", "in": "query", "schema": { "type": [ "string", "null" ] } }, { "name": "date", "in": "query", "schema": { "type": [ "string", "null" ], "format": "date-time" } }, { "name": "startDate", "in": "query", "schema": { "type": [ "string", "null" ], "format": "date-time" } }, { "name": "endDate", "in": "query", "schema": { "type": [ "string", "null" ], "format": "date-time" } }, { "name": "sort", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "date", "name", "email", "phone", "wtl" ] } }, { "name": "direction", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "string" }, "total": { "type": "string" } }, "required": [ "success", "total" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } }, "post": { "operationId": "registrant.create", "summary": "CSV upload through UI, for registration see SubscriberController@registration", "tags": [ "Registrant" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "webinarTimeline": { "type": "string" }, "csv": { "type": "string" } }, "required": [ "webinarTimeline" ] } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "integer", "minimum": 0 } }, "required": [ "success" ] } } } }, "403": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "" } }, "required": [ "message" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "410": { "description": "An error\n\nAn error", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "No upcoming visible webinars exist for this timeline." } }, "required": [ "message" ] }, { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "Could not find timeline settings. Please try again later or recreate the timeline." } }, "required": [ "message" ] } ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/registrants/{registrantID}": { "get": { "operationId": "registrant.show", "tags": [ "Registrant" ], "parameters": [ { "name": "registrantID", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "$ref": "#/components/schemas/RegistrantResource" } }, "required": [ "success" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/registrants/{registrant}": { "put": { "operationId": "registrant.update", "tags": [ "Registrant" ], "parameters": [ { "name": "registrant", "in": "path", "required": true, "description": "The registrant uniqueid", "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "phone": { "type": [ "string", "null" ] }, "firstName": { "type": [ "string", "null" ] }, "lastName": { "type": [ "string", "null" ] }, "landingPage": { "type": [ "string", "null" ], "format": "uri" }, "country": { "type": [ "string", "null" ], "maxLength": 2 }, "city": { "type": [ "string", "null" ], "maxLength": 50 }, "state": { "type": [ "string", "null" ], "maxLength": 50 }, "ipAddress": { "type": [ "string", "null" ] }, "timezone": { "type": [ "string", "null" ] }, "customFields": { "type": [ "array", "null" ], "items": { "type": "string" } }, "webhooks": { "type": [ "array", "null" ], "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "`RegistrantResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RegistrantResource" } }, "required": [ "data" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } }, "delete": { "operationId": "registrant.destroy", "tags": [ "Registrant" ], "parameters": [ { "name": "registrant", "in": "path", "required": true, "description": "The registrant uniqueid", "schema": { "type": "integer" } } ], "responses": { "204": { "description": "No content", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/registrants/ban": { "post": { "operationId": "registrant.ban", "tags": [ "Registrant" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "uuid": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ], "format": "email" }, "emails": { "type": [ "array", "null" ], "items": { "type": "string", "format": "email" } } } } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/registrants/unban": { "post": { "operationId": "registrant.unban", "tags": [ "Registrant" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "emails": { "type": "object" } } } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "410": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "No matching registrants found." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/registration": { "post": { "operationId": "subscriber.registration", "summary": "Adds a new registrant. Use /api-registration for programmatic registration", "tags": [ "Subscriber" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "string" }, { "type": "object" } ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" } } } }, "/registration/inner": { "post": { "operationId": "subscriber.innerRegistration_0", "summary": "Subscriber inner registration\nHandles additional fields like phone number", "tags": [ "Subscriber" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "uuid": { "type": "string" }, "phone": { "type": "string" } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/registration/phone": { "post": { "operationId": "subscriber.innerRegistration_0", "summary": "Subscriber inner registration\nHandles additional fields like phone number", "tags": [ "Subscriber" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/current-viewers": { "get": { "operationId": "currentViewers", "tags": [ "Subscriber" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "string" }, "webinars": { "type": "integer" } }, "required": [ "total", "webinars" ] } } } } } } }, "/webinartimelinemaster/copy": { "post": { "operationId": "timeline.copyWebinarTimelineMaster", "summary": "Copy Timeline", "tags": [ "Timeline" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "webinarTimeline": { "type": "string" }, "timelineName": { "type": "string" }, "findAndReplace": { "type": [ "string", "null" ] } }, "required": [ "webinarTimeline", "timelineName" ] } } } }, "responses": { "400": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } } } }, "201": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "string" } }, "required": [ "success" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/webinartimelinemaster/share": { "post": { "operationId": "timeline.share", "summary": "Share Timeline", "tags": [ "Timeline" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "timeline": { "type": "string" } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "string" } }, "required": [ "success" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/webinartimelinemaster/get": { "post": { "operationId": "timeline.getWebinarTimelineMaster", "summary": "Get timeline and add general settings (name, description, etc", "tags": [ "Timeline" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "webinarTimeline": { "type": "string" }, "uniqueID": { "type": "string" }, "filter": { "type": "string", "enum": [ "trash" ] } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/webinartimelinemaster/set": { "post": { "operationId": "timeline.setWebinarTimelineMaster", "summary": "Save timeline with all settings", "tags": [ "Timeline" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "blocks": { "type": "string" }, "webinarTimeline": { "type": "string" } }, "required": [ "blocks", "webinarTimeline" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/webinartimelinemaster/copysetting": { "put": { "operationId": "copySetting", "summary": "Copy Setting to Another Timeline", "tags": [ "Timeline" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "copyFrom": { "type": "string" }, "copyTo": { "type": "string" }, "setting": { "type": "string" } }, "required": [ "copyFrom", "copyTo", "setting" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/webinartimelinemaster/set/item": { "post": { "operationId": "timeline.setWebinarTimelineMasterItem", "summary": "Save a specific timeline setting\nSupports dot notation (e.g. general.multiEvents)", "tags": [ "Timeline" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "webinarTimeline": { "type": "string" }, "key": { "type": "string" }, "setting": { "type": "string" }, "value": { "type": "string" } }, "required": [ "webinarTimeline", "key", "setting", "value" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "An error\n\nAn error", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "Invalid JSON value." } }, "required": [ "message" ] }, { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "" } }, "required": [ "message" ] } ] } } } }, "410": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "No general setting found." } }, "required": [ "message" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/webinartimelinemaster/restore": { "post": { "operationId": "timeline.restore", "tags": [ "Timeline" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "webinarTimeline": { "type": "string" } }, "required": [ "webinarTimeline" ] } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] } } } }, "410": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "" } }, "required": [ "message" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/webinartimelineevent/set": { "post": { "operationId": "timeline.setWebinarTimelineEvent", "summary": "Save timeline actions and add parsed system-type actions on webinar_timelines table", "tags": [ "Timeline" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "webinarTimeline": { "type": "string" }, "blocks": { "type": "string" }, "initializeTemplate": { "type": "string" } }, "required": [ "webinarTimeline", "blocks" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "410": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "Campaign not found." } }, "required": [ "message" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/webinartimelineevent/get": { "post": { "operationId": "timeline.getWebinarTimelineEvent", "summary": "Get Timeline Actions", "tags": [ "Timeline" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "webinarTimeline": { "type": "string" } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/webinartimelineevent/get/code": { "post": { "operationId": "timeline.eventsByCode", "summary": "Events by Code (Sharing feature)", "tags": [ "Timeline" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "success": { "type": "string" } }, "required": [ "success" ] }, { "type": "object", "properties": { "error": { "type": "string", "enum": [ "Could not find webinar timeline." ] } }, "required": [ "error" ] }, { "type": "object" } ] } } } }, "410": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "" } }, "required": [ "message" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/webinartimelineevent/autocsv": { "post": { "operationId": "timeline.autochatCSV", "summary": "Handle Autochat bulk CSV upload", "tags": [ "Timeline" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "webinarTimeline": { "type": "string" }, "eventID": { "type": "string" }, "csv": { "type": "string" } }, "required": [ "webinarTimeline" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "": { "type": "integer", "enum": [ 200 ] } }, "required": [ "success", null ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/webinartimelineevent/{events}/import": { "post": { "operationId": "timeline.actionCSV", "tags": [ "Timeline" ], "parameters": [ { "name": "events", "in": "path", "required": true, "description": "The events uniqueid", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "action": { "type": "string" }, "csv": { "type": "string" } }, "required": [ "action" ] } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "string" } }, "required": [ "success" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/webinartimeline/delete": { "post": { "operationId": "timeline.deleteWebinarTimeline", "summary": "Delete Timeline", "tags": [ "Timeline" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "webinarTimeline": { "type": "string" } }, "required": [ "webinarTimeline" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/webinartimeline/check_if_used": { "post": { "operationId": "timeline.checkWebinarTimelineIfUsed", "summary": "Check if timeline is used by any webinars\nUsed before removal", "tags": [ "Timeline" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "webinarTimeline": { "type": "string" } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/generalsetting/create": { "post": { "operationId": "timeline.createGeneralSetting", "summary": "Create timeline and its setting nodes", "tags": [ "Timeline" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "blocks": { "type": "string" } }, "required": [ "blocks" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/generalsetting/get": { "post": { "operationId": "timeline.getGeneralSetting", "summary": "Get General Setting\nPARAM => nodeID : ( general, autoresponder, integration, ... ), webinarTimeline", "tags": [ "Timeline" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "webinarTimeline": { "type": "string" }, "nodeID": { "type": "string" } }, "required": [ "webinarTimeline", "nodeID" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "$ref": "#/components/schemas/SettingResource" } }, "required": [ "success" ] } } } }, "410": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "Setting not found." } }, "required": [ "message" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/timelines/{webinarTimeline}/revisions": { "get": { "operationId": "timeline.revisions", "tags": [ "Timeline" ], "parameters": [ { "name": "webinarTimeline", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "object", "additionalProperties": {} } }, "required": [ "success" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/timeline/{timeline}/validate": { "get": { "operationId": "timeline.validateTimeline", "tags": [ "Timeline" ], "parameters": [ { "name": "timeline", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "webinarTimeline", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" }, "403": { "$ref": "#/components/responses/AuthorizationException" } } } }, "/webinars": { "get": { "operationId": "webinars.index", "summary": "List paginated scheduled webinars, for home view", "tags": [ "Webinar" ], "parameters": [ { "name": "count", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "string" } }, { "name": "type", "in": "query", "schema": { "type": "string" } }, { "name": "wtl", "in": "query", "schema": { "type": "string" } }, { "name": "version", "in": "query", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "date", "time", "type", "wtl", "platform", "application", "registrants", "automation", "trash" ] } }, { "name": "direction", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc", "ZOOM", "AEVENT", "OBVIO", "GOTOWEBINAR", "YOUTUBE" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "string" }, "total": { "type": "string" } }, "required": [ "success", "total" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/webinars/{webinar}/recordings": { "post": { "operationId": "webinar.encodeRecording", "tags": [ "Webinar" ], "parameters": [ { "name": "webinar", "in": "path", "required": true, "description": "The webinar webinarid", "schema": { "type": [ "string", "null" ] } } ], "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/webinar/create": { "post": { "operationId": "createWebinar", "description": "Create WebinarTimelineMaster with GeneralSettings first\nand then create webinar with the TimelineID from the Master", "summary": "Create Webinar", "tags": [ "Webinar" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateWebinarRequest" }, { "type": "object", "properties": { "isEditing": { "type": "string" }, "occurrenceID": { "type": "string" }, "webinarID": { "type": "string" }, "uniqueID": { "type": "string" } } } ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "410": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "Nothing to edit." } }, "required": [ "message" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/webinar/update": { "post": { "operationId": "webinar.updateWebinar", "summary": "Update Webinar", "tags": [ "Webinar" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "webinarID": { "type": "string" }, "blocks": { "type": "string" } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "string" } }, "required": [ "success" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/webinar/delete": { "post": { "operationId": "webinar.deleteWebinar", "summary": "Delete Webinar", "tags": [ "Webinar" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "webinarID": { "type": "string" }, "isRecurring": { "type": "string", "enum": [ "true", "false" ] }, "uniqueID": { "type": [ "number", "null" ] }, "selectedTimeStamp": { "type": [ "number", "null" ] } }, "required": [ "webinarID" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/stream/webinar/coorganizer": { "post": { "operationId": "webinar.registerCoOrganizer", "summary": "Add co-organizer to a webinar", "tags": [ "Webinar" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tenantId": { "type": "string" }, "webinarId": { "type": "string" }, "name": { "type": "string", "maxLength": 191 }, "email": { "type": "string", "format": "email" }, "phone": { "type": [ "string", "null" ], "maxLength": 24 } }, "required": [ "email" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" }, "403": { "$ref": "#/components/responses/AuthorizationException" } } } }, "/recurring": { "get": { "operationId": "webinar.recurring", "summary": "List recurring webinars", "tags": [ "Webinar" ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": [ "number", "null" ] } }, { "name": "count", "in": "query", "schema": { "type": [ "number", "null" ] } }, { "name": "wtl", "in": "query", "schema": { "type": [ "string", "null" ] } }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "wtl", "date", "time", "platform", "trash" ] } }, { "name": "direction", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "name": "platform", "in": "query", "schema": { "type": "string", "enum": [ "evergreen", "ZOOM", "AEVENT", "OBVIO", "GOTOWEBINAR", "YOUTUBE" ] } }, { "name": "trash", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "true", "false" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "$ref": "#/components/schemas/RecurringCollection" }, "total": { "type": "string" }, "total_pages": { "type": "string" } }, "required": [ "success", "total", "total_pages" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/recurring/{uniqueID}": { "delete": { "operationId": "webinar.deleteRecurring", "summary": "Delete a recurring webinar", "tags": [ "Webinar" ], "parameters": [ { "name": "uniqueID", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "400": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "" } }, "required": [ "message" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/recurring/restore": { "post": { "operationId": "webinar.restoreRecurring", "tags": [ "Webinar" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "uniqueID": { "type": "string" } }, "required": [ "uniqueID" ] } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/webinars/{webinar}": { "get": { "operationId": "webinar.show", "summary": "Get a specific webinar", "tags": [ "Webinar" ], "parameters": [ { "name": "webinar", "in": "path", "required": true, "description": "The webinar webinarid", "schema": { "type": [ "string", "null" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "$ref": "#/components/schemas/WebinarResource" } }, "required": [ "success" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/webinars/{webinar}/agents": { "get": { "operationId": "webinar.agents", "summary": "Return agent data for webinar", "tags": [ "Webinar" ], "parameters": [ { "name": "webinar", "in": "path", "required": true, "description": "The webinar webinarid", "schema": { "type": [ "string", "null" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "success": { "type": "string" } }, "required": [ "success" ] } }, "required": [ "data" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/webinars/{webinar}/hosts": { "get": { "operationId": "webinar.getAlternativeHosts", "summary": "Get alternative host options", "tags": [ "Webinar" ], "parameters": [ { "name": "webinar", "in": "path", "required": true, "description": "The webinar webinarid", "schema": { "type": [ "string", "null" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "success": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] } }, "required": [ "success" ] } }, "required": [ "data" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/webinar/update/integration": { "post": { "operationId": "webinar.updateIntegrationForWebinars", "tags": [ "Webinar" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "webinarIDs": { "type": "string" }, "integrationID": { "type": "string" }, "originalIntegrationID": { "type": "string" } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] } } } }, "422": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "" } }, "required": [ "message" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/webinar/integration": { "post": { "operationId": "webinar.updateIntegrationForWebinar", "tags": [ "Webinar" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "webinarID": { "type": "string" }, "integrationID": { "type": "string" } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "success": { "type": "string", "enum": [ "overlap" ] } }, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "type": "string" } }, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "type": "string", "enum": [ "success" ] } }, "required": [ "success" ] } ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/webinar/delete/failed": { "post": { "operationId": "webinar.deleteWebinarFailed", "tags": [ "Webinar" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "webinarIDs": { "type": "string" } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/webinar/status": { "post": { "operationId": "webinar.getWebinarStatus", "summary": "Webinar Status", "tags": [ "Webinar" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "webinarID": { "type": "string" } }, "required": [ "webinarID" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "object", "properties": { "registrants": { "type": [ "object", "null" ] }, "phone": { "type": "string" }, "action": { "type": "string" }, "report": { "type": "string" } }, "required": [ "registrants", "phone", "action", "report" ] } }, "required": [ "success" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/webinar/status/location": { "post": { "operationId": "webinar.getAudienceLocation", "summary": "Audience Location", "tags": [ "Webinar" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "webinarID": { "type": "string" }, "groupID": { "type": "string" } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "string" } }, "required": [ "success" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/webinar/question": { "post": { "operationId": "webinar.getWebinarQuestion", "summary": "Webinar Question", "tags": [ "Webinar" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "webinarID": { "type": "string" } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/webinar/checkWebinarTimezone": { "post": { "operationId": "webinar.checkWebinarTimezone", "summary": "Check Webinar Timezone", "tags": [ "Webinar" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "before": { "type": "string" }, "after": { "type": "string" } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/webinar/upcoming": { "post": { "operationId": "webinar.getUpcomingWebinars", "summary": "List of webinars that can be attached", "tags": [ "Webinar" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "integrationID": { "type": "string" } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "success": { "type": "string" } }, "required": [ "success" ] }, { "type": "object", "properties": { "success": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "success" ] } ] } } } }, "422": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "enum": [ "Integration disconnected." ] } }, "required": [ "error" ] } } } }, "410": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "" } }, "required": [ "message" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/wizard/templates": { "post": { "operationId": "templates.index", "tags": [ "Wizard" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "search": { "type": [ "string", "null" ] } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "string" } }, "required": [ "success" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/wizard/templates/{template}": { "post": { "operationId": "templates.show", "tags": [ "Wizard" ], "parameters": [ { "name": "template", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "webinarTimelines": { "type": "string" } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "string" } }, "required": [ "success" ] } } } }, "422": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "webinarTimelines must be an array." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } } }, "components": { "schemas": { "ActionType": { "type": "string", "enum": [ "AddUTM", "AddField", "ClearJoinMessages", "AddJoinMessage", "ShowCampaign", "ListUpcomingWebinars", "ListPastWebinars", "ListRecurring", "ListCampaigns", "AddTextMessage", "ListAudiences", "ListIntegrations", "ListCampaignIntegrations", "ListMultiEvents", "ShowEventInfo", "ScheduleWebinar", "ShowTranscript", "TestIntegration", "SetConfirmationPage", "SetExpiredPage", "SetReplayPage", "SetReplaySequence", "AddAdditionalEvent", "ListVideos", "SwitchVideo", "CreateCampaign", "CheckPage", "ShowLead", "SearchDocumentation" ], "title": "ActionType" }, "CreateFormRequest": { "type": "object", "properties": { "removedHeader": { "type": "boolean" }, "formItems": { "type": "array", "items": { "type": "string" } }, "formBody": { "type": "array", "items": { "type": "string" } }, "backgroundColor": { "type": "string" }, "updatedDate": { "type": "string", "format": "date-time" }, "templateName": { "type": "string" }, "type": { "type": "string" }, "font": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "formItems", "formBody", "backgroundColor", "updatedDate", "templateName", "type" ], "title": "CreateFormRequest" }, "CreateMediaRequest": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "folder", "video/mp4", "video/quicktime", "image/png", "image/jpeg", "image/gif", "jpg", "image/jpeg", "image/tiff", "image/x-icon", "image/vnd.microsoft.icon", "audio/wav", "audio/x-wav", "audio/mpeg", "audio/mp4", "audio/m4a", "audio/x-m4a", "audio/mp3", "application/x-rar", "application/octet-stream", "text/vtt" ] }, "size": { "type": "number" }, "ext": { "type": "string", "enum": [ "mp4", "hevc", "mp3", "wav", "m4a", "jpg", "jpeg", "png", "gif", "tiff", "ico", "vtt" ] }, "upload_path": { "type": "string" }, "upload_url": { "type": "string" }, "video_length": { "type": "string" }, "thumbnail": { "type": "string" }, "folderID": { "type": [ "string", "null" ] }, "transcoding": { "type": "integer" } }, "title": "CreateMediaRequest" }, "CreateWebinarRequest": { "type": "object", "properties": { "integrationID": { "type": [ "string", "null" ] }, "timestamp": { "type": "string" }, "webinarTimeline": { "type": "string" }, "type": { "type": [ "string", "null" ], "enum": [ "single_session", "recurring" ] }, "overlapIntegrationID": { "type": [ "string", "null" ] }, "experienceType": { "$ref": "#/components/schemas/ExperienceType" }, "recurring": { "type": "string" }, "timezone": { "type": [ "string", "null" ] }, "attachTo": { "type": "string" }, "recurringID": { "type": "string" }, "hidden": { "type": [ "string", "null" ] }, "encore": { "type": [ "string", "null" ] } }, "required": [ "timestamp", "webinarTimeline" ], "title": "CreateWebinarRequest" }, "ExperienceType": { "type": "string", "description": "webinars.mode column.\n", "enum": [ "WEB", "OBVIO", "YOUTUBE", "MEETING", "WEBINAR", "CLASSIC", "BROADCAST" ], "title": "ExperienceType" }, "IntegrationData": { "type": "object", "properties": { "id": { "type": "integer" }, "integrationID": { "type": "string" }, "nodeID": { "type": [ "string", "null" ] }, "blocks": { "type": "array", "items": {} }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "integrationID", "nodeID", "blocks", "created_at", "updated_at" ], "title": "IntegrationData" }, "LocationType": { "type": "string", "enum": [ "country", "state", "city" ], "title": "LocationType" }, "RecurringCollection": { "type": "array", "items": { "$ref": "#/components/schemas/RecurringResource" }, "title": "RecurringCollection" }, "RecurringResource": { "anyOf": [ { "type": "array", "items": {} }, { "type": "object" } ], "title": "RecurringResource" }, "RegionalFilter": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false, "title": "RegionalFilter" }, "RegistrantResource": { "type": "object", "additionalProperties": {}, "title": "RegistrantResource" }, "SaveInputRequest": { "type": "object", "properties": { "type": { "type": "string" }, "value": { "type": "string" } }, "required": [ "type", "value" ], "title": "SaveInputRequest" }, "SettingResource": { "type": "array", "items": {}, "title": "SettingResource" }, "UpdateFormRequest": { "type": "object", "properties": { "removedHeader": { "type": "boolean" }, "formItems": { "type": "array", "items": { "type": "string" } }, "formBody": { "type": "array", "items": { "type": "string" } }, "backgroundColor": { "type": "string" }, "updatedDate": { "type": "string", "format": "date-time" }, "font": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "formItems", "formBody", "backgroundColor", "updatedDate" ], "title": "UpdateFormRequest" }, "UpdateMediaRequest": { "type": "object", "properties": { "fileId": { "type": "string" }, "upload_url": { "type": "string" }, "transcoding": { "type": "number" }, "folderID": { "type": [ "string", "null" ] }, "video_length": { "type": "string" }, "files": { "type": "object" } }, "title": "UpdateMediaRequest" }, "UserFile": { "type": "object", "properties": { "uniqueID": { "type": "integer" }, "uuid": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "type": { "type": "string" }, "size": { "type": "string" }, "ext": { "type": "string" }, "upload_path": { "type": "string" }, "upload_url": { "type": "string" }, "video_length": { "type": "string" }, "thumbnail": { "type": "string" }, "cache_path": { "type": "string" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "transcoding": { "type": "integer" } }, "required": [ "uniqueID", "uuid", "name", "type", "size", "ext", "upload_path", "upload_url", "video_length", "thumbnail", "cache_path", "created_at", "updated_at", "transcoding" ], "title": "UserFile" }, "WebinarResource": { "type": "object", "properties": { "affID": { "type": [ "string", "null" ] }, "coOrganizer": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "customIntro": { "type": [ "string", "null" ] }, "generalSettingID": { "type": "string" }, "integrationID": { "type": [ "string", "null" ] }, "mode": { "type": [ "string", "null" ] }, "recurring": { "type": [ "string", "null" ] }, "registrants": { "type": "string" }, "serverID": { "type": [ "string", "null" ] }, "timeStamp": { "type": [ "string", "null" ] }, "timerLength": { "type": [ "integer", "null" ] }, "timestamp": { "type": "string" }, "timeZone": { "type": [ "string", "null" ] }, "tracks": { "type": "array", "items": { "$ref": "#/components/schemas/WebinarTrack" } }, "type": { "type": [ "string", "null" ] }, "statuses": { "type": "array", "items": { "$ref": "#/components/schemas/WebinarStatus" } }, "uniqueID": { "type": "integer" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "uuid": { "type": [ "string", "null" ] }, "version": { "type": [ "string", "null" ] }, "visible": { "type": "integer" }, "webinarID": { "type": [ "string", "null" ] }, "webinarStarted": { "type": [ "integer", "null" ] }, "webinarTimeline": { "type": [ "string", "null" ] }, "userGroup": { "type": [ "string", "null" ] }, "startsIn": { "type": [ "object", "null" ] }, "expiresIn": { "type": [ "object", "null" ] }, "occurrenceID": { "type": "string" } }, "required": [ "affID", "coOrganizer", "created_at", "customIntro", "generalSettingID", "integrationID", "mode", "recurring", "registrants", "serverID", "timeStamp", "timerLength", "timestamp", "timeZone", "tracks", "type", "statuses", "uniqueID", "updated_at", "uuid", "version", "visible", "webinarID", "webinarStarted", "webinarTimeline", "userGroup", "startsIn", "expiresIn", "occurrenceID" ], "title": "WebinarResource" }, "WebinarStatus": { "type": "object", "properties": { "uniqueID": { "type": "integer" }, "webinarID": { "type": "string" }, "nodeID": { "type": "string" }, "blocks": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "uniqueID", "webinarID", "nodeID", "blocks", "created_at", "updated_at" ], "title": "WebinarStatus" }, "WebinarTrack": { "type": "object", "properties": { "id": { "type": "integer" }, "webinarID": { "type": "string" }, "type": { "type": "string" }, "log": { "type": "string" }, "timestamp": { "type": "string" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "webinarID", "type", "log", "timestamp", "created_at", "updated_at" ], "title": "WebinarTrack" } }, "responses": { "ValidationException": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Errors overview." }, "errors": { "type": "object", "description": "A detailed description of each field that failed validation.", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "required": [ "message", "errors" ] } } } }, "AuthorizationException": { "description": "Authorization error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview." } }, "required": [ "message" ] } } } }, "AuthenticationException": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview." } }, "required": [ "message" ] } } } }, "ModelNotFoundException": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview." } }, "required": [ "message" ] } } } } } } }