{ "openapi": "3.1.0", "info": { "title": "Laravel", "version": "1.0.0", "description": "BYOMailer API. Authenticate with a personal API token from Settings \u2192 API Tokens. All endpoints are scoped to the authenticated user's client. Unversioned `/api/` paths receive a 308 Permanent Redirect to `/api/v1/`." }, "servers": [ { "url": "https://byomailer.com/api/v1", "description": "Production" } ], "paths": { "/blocks": { "get": { "operationId": "v1.blocks.index", "tags": [ "Block" ], "responses": { "200": { "description": "Array of `BlockResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BlockResource" } } }, "required": [ "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } }, "post": { "operationId": "v1.blocks.store", "tags": [ "Block" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockRequest" } } } }, "responses": { "201": { "description": "`BlockResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BlockResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } } }, "/blocks/{blockId}": { "get": { "operationId": "v1.blocks.show", "tags": [ "Block" ], "parameters": [ { "name": "blockId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`BlockResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BlockResource" } }, "required": [ "data" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } }, "patch": { "operationId": "v1.blocks.update", "tags": [ "Block" ], "parameters": [ { "name": "blockId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockRequest" } } } }, "responses": { "200": { "description": "`BlockResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BlockResource" } }, "required": [ "data" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } }, "delete": { "operationId": "v1.blocks.destroy", "tags": [ "Block" ], "parameters": [ { "name": "blockId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "No content" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/contacts": { "get": { "operationId": "v1.contacts.index", "tags": [ "Contact" ], "responses": { "200": { "description": "Array of `ContactResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ContactResource" } } }, "required": [ "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/contacts/{contactId}": { "get": { "operationId": "v1.contacts.show", "tags": [ "Contact" ], "parameters": [ { "name": "contactId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ContactResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ContactResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } }, "put": { "operationId": "v1.contacts.update", "tags": [ "Contact" ], "parameters": [ { "name": "contactId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactRequest" } } } }, "responses": { "200": { "description": "`ContactResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ContactResource" } }, "required": [ "data" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } }, "patch": { "operationId": "v1.", "tags": [ "Contact" ], "parameters": [ { "name": "contactId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactRequest" } } } }, "responses": { "200": { "description": "`ContactResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ContactResource" } }, "required": [ "data" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } } }, "/lists/{listId}/contacts": { "post": { "operationId": "v1.lists.contacts.store", "tags": [ "Contact" ], "parameters": [ { "name": "listId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } } }, "/contacts/{contactId}/unsubscribe": { "post": { "operationId": "v1.contacts.unsubscribe", "tags": [ "Contact" ], "parameters": [ { "name": "contactId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ContactResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ContactResource" } }, "required": [ "data" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/lists/{listId}/contacts/{contactId}": { "delete": { "operationId": "v1.lists.contacts.destroy", "tags": [ "Contact" ], "parameters": [ { "name": "listId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contactId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ContactResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ContactResource" } }, "required": [ "data" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/email-identities": { "get": { "operationId": "v1.email-identities.index", "tags": [ "EmailIdentity" ], "parameters": [ { "name": "identity_status", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Array of `EmailIdentityResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/EmailIdentityResource" } } }, "required": [ "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/email-identities/{emailIdentityId}": { "get": { "operationId": "v1.email-identities.show", "tags": [ "EmailIdentity" ], "parameters": [ { "name": "emailIdentityId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`EmailIdentityResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/EmailIdentityResource" } }, "required": [ "data" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/email-logs": { "get": { "operationId": "v1.email-logs.index", "tags": [ "EmailLog" ], "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "operation", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Array of `EmailLogResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/EmailLogResource" } } }, "required": [ "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/email-logs/{emailLogId}": { "get": { "operationId": "v1.email-logs.show", "tags": [ "EmailLog" ], "parameters": [ { "name": "emailLogId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`EmailLogResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/EmailLogResource" } }, "required": [ "data" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/email-templates": { "get": { "operationId": "v1.email-templates.index", "tags": [ "EmailTemplate" ], "parameters": [ { "name": "per_page", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "archived", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "is_default", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Array of `EmailTemplateResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/EmailTemplateResource" } } }, "required": [ "data" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/email-templates/default": { "get": { "operationId": "v1.email-templates.default", "tags": [ "EmailTemplate" ], "responses": { "200": { "description": "`EmailTemplateResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/EmailTemplateResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/email-templates/{emailTemplateId}": { "get": { "operationId": "v1.email-templates.show", "tags": [ "EmailTemplate" ], "parameters": [ { "name": "emailTemplateId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`EmailTemplateResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/EmailTemplateResource" } }, "required": [ "data" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/lists": { "get": { "operationId": "v1.lists.index", "tags": [ "MailList" ], "parameters": [ { "name": "per_page", "in": "query", "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Array of `MailListResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MailListResource" } } }, "required": [ "data" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } }, "post": { "operationId": "v1.lists.store", "tags": [ "MailList" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailListRequest" } } } }, "responses": { "201": { "description": "`MailListResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MailListResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } } }, "/lists/{listId}": { "patch": { "operationId": "v1.lists.update", "tags": [ "MailList" ], "parameters": [ { "name": "listId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailListRequest" } } } }, "responses": { "200": { "description": "`MailListResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MailListResource" } }, "required": [ "data" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } }, "delete": { "operationId": "v1.lists.destroy", "tags": [ "MailList" ], "parameters": [ { "name": "listId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "No content" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/newsletters": { "get": { "operationId": "v1.newsletters.index", "tags": [ "Newsletter" ], "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string", "enum": [ "draft", "scheduled", "queued", "ab_testing", "sent", "failed" ] } }, { "name": "search", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 255 } }, { "name": "project", "in": "query", "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "cursor", "in": "query", "schema": { "type": [ "string", "null" ] } } ], "responses": { "200": { "description": "Array of `NewsletterResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/NewsletterResource" } } }, "required": [ "data" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } }, "post": { "operationId": "v1.newsletters.store", "tags": [ "Newsletter" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreNewsletterRequest" } } } }, "responses": { "201": { "description": "`NewsletterResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/NewsletterResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } } }, "/newsletters/{newsletterId}": { "get": { "operationId": "v1.newsletters.show", "tags": [ "Newsletter" ], "parameters": [ { "name": "newsletterId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`NewsletterResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/NewsletterResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } }, "patch": { "operationId": "v1.newsletters.update", "tags": [ "Newsletter" ], "parameters": [ { "name": "newsletterId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateNewsletterRequest" } } } }, "responses": { "200": { "description": "`NewsletterResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/NewsletterResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } }, "delete": { "operationId": "v1.newsletters.destroy", "tags": [ "Newsletter" ], "parameters": [ { "name": "newsletterId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "No content" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/newsletters/{newsletterId}/ab-winner": { "post": { "operationId": "v1.newsletters.ab-winner", "tags": [ "NewsletterAbWinner" ], "parameters": [ { "name": "newsletterId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewsletterAbWinnerRequest" } } } }, "responses": { "200": { "description": "`NewsletterResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/NewsletterResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } } }, "/newsletters/contacts/preview": { "post": { "operationId": "v1.newsletters.contacts.preview", "tags": [ "NewsletterContactsPreview" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewsletterContactsPreviewRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0 } }, "required": [ "count" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } } }, "/newsletters/{newsletterId}/test-mail": { "post": { "operationId": "v1.newsletters.test-mail", "tags": [ "NewsletterTestMail" ], "parameters": [ { "name": "newsletterId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "sent_to": { "type": "string" } }, "required": [ "message", "sent_to" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/newsletters/{newsletterId}/variables": { "get": { "operationId": "v1.newsletters.variables.show", "tags": [ "NewsletterVariables" ], "parameters": [ { "name": "newsletterId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "newsletter_id": { "type": "string" }, "detected_variables": { "type": "array", "items": { "type": "string" } }, "content_variables": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "newsletter_id", "detected_variables", "content_variables" ] } }, "required": [ "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/projects": { "get": { "operationId": "v1.projects.index", "tags": [ "Project" ], "parameters": [ { "name": "per_page", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "cursor", "in": "query", "schema": { "type": [ "string", "null" ] } } ], "responses": { "200": { "description": "Array of `ProjectResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectResource" } } }, "required": [ "data" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } }, "post": { "operationId": "v1.projects.store", "tags": [ "Project" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreProjectRequest" } } } }, "responses": { "201": { "description": "`ProjectResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProjectResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } } }, "/projects/{projectId}": { "get": { "operationId": "v1.projects.show", "tags": [ "Project" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ProjectResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProjectResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } }, "patch": { "operationId": "v1.projects.update", "tags": [ "Project" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProjectRequest" } } } }, "responses": { "200": { "description": "`ProjectResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProjectResource" } }, "required": [ "data" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } }, "delete": { "operationId": "v1.projects.destroy", "tags": [ "Project" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "No content" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/sequences": { "get": { "operationId": "v1.sequences.index", "tags": [ "Sequence" ], "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string", "enum": [ "" ] } }, { "name": "search", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 255 } }, { "name": "project", "in": "query", "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "cursor", "in": "query", "schema": { "type": [ "string", "null" ] } } ], "responses": { "200": { "description": "Array of `SequenceResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SequenceResource" } } }, "required": [ "data" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/sequences/{sequenceId}": { "get": { "operationId": "v1.sequences.show", "tags": [ "Sequence" ], "parameters": [ { "name": "sequenceId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`SequenceResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SequenceResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/sequences/{sequenceId}/stats": { "get": { "operationId": "v1.sequences.stats", "tags": [ "SequenceStats" ], "parameters": [ { "name": "sequenceId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`SequenceStatsResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SequenceStatsResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/sequences/{sequenceId}/steps/{sequenceStepId}": { "get": { "operationId": "v1.sequences.steps.show", "tags": [ "SequenceStep" ], "parameters": [ { "name": "sequenceId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "sequenceStepId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`SequenceStepResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SequenceStepResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/sequences/{sequenceId}/steps/{sequenceStepId}/filters": { "patch": { "operationId": "v1.sequences.steps.filters.update", "summary": "Replace the audience filters of one sequence step. A contact who does\nnot match them skips only this step's email. An empty array clears them", "tags": [ "SequenceStepFilters" ], "parameters": [ { "name": "sequenceId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "sequenceStepId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SequenceStepFiltersRequest" } } } }, "responses": { "200": { "description": "`SequenceStepResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SequenceStepResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } } }, "/sequences/{sequenceId}/steps/{sequenceStepId}/stats": { "get": { "operationId": "v1.sequences.steps.stats", "tags": [ "SequenceStepStats" ], "parameters": [ { "name": "sequenceId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "sequenceStepId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`SequenceStepStatsResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SequenceStepStatsResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/tags": { "get": { "operationId": "v1.tags.index", "tags": [ "Tag" ], "responses": { "200": { "description": "Array of `TagResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TagResource" } } }, "required": [ "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } }, "post": { "operationId": "v1.tags.store", "tags": [ "Tag" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagRequest" } } } }, "responses": { "201": { "description": "`TagResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TagResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } } }, "/tags/{tagId}": { "patch": { "operationId": "v1.tags.update", "tags": [ "Tag" ], "parameters": [ { "name": "tagId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagRequest" } } } }, "responses": { "200": { "description": "`TagResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TagResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } }, "delete": { "operationId": "v1.tags.destroy", "tags": [ "Tag" ], "parameters": [ { "name": "tagId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/lists/{listId}/topics": { "get": { "operationId": "v1.lists.topics.index", "tags": [ "Topic" ], "parameters": [ { "name": "listId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Array of `TopicResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TopicResource" } } }, "required": [ "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } }, "post": { "operationId": "v1.lists.topics.store", "tags": [ "Topic" ], "parameters": [ { "name": "listId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TopicRequest" } } } }, "responses": { "201": { "description": "`TopicResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TopicResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } } }, "/lists/{listId}/topics/{topicId}": { "patch": { "operationId": "v1.lists.topics.update", "tags": [ "Topic" ], "parameters": [ { "name": "listId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "topicId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TopicRequest" } } } }, "responses": { "200": { "description": "`TopicResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TopicResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } } }, "delete": { "operationId": "v1.lists.topics.destroy", "tags": [ "Topic" ], "parameters": [ { "name": "listId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "topicId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/webhook-endpoints": { "get": { "operationId": "v1.webhook-endpoints.index", "tags": [ "WebhookEndpoint" ], "responses": { "200": { "description": "Array of `WebhookEndpointResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookEndpointResource" } } }, "required": [ "data" ] } } } }, "403": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "" } }, "required": [ "message" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } }, "post": { "operationId": "v1.webhook-endpoints.store", "tags": [ "WebhookEndpoint" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreWebhookEndpointRequest" } } } }, "responses": { "201": { "description": "`WebhookEndpointResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WebhookEndpointResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" }, "403": { "$ref": "#/components/responses/AuthorizationException" } } } }, "/webhook-endpoints/{webhookEndpointId}": { "get": { "operationId": "v1.webhook-endpoints.show", "tags": [ "WebhookEndpoint" ], "parameters": [ { "name": "webhookEndpointId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`WebhookEndpointResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WebhookEndpointResource" } }, "required": [ "data" ] } } } }, "403": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "" } }, "required": [ "message" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } }, "patch": { "operationId": "v1.webhook-endpoints.update", "tags": [ "WebhookEndpoint" ], "parameters": [ { "name": "webhookEndpointId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWebhookEndpointRequest" } } } }, "responses": { "200": { "description": "`WebhookEndpointResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WebhookEndpointResource" } }, "required": [ "data" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "403": { "$ref": "#/components/responses/AuthorizationException" } } }, "delete": { "operationId": "v1.webhook-endpoints.destroy", "tags": [ "WebhookEndpoint" ], "parameters": [ { "name": "webhookEndpointId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "No content" }, "403": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "" } }, "required": [ "message" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/webhook-endpoints/{webhookEndpointId}/deliveries": { "get": { "operationId": "v1.webhook-endpoints.deliveries", "tags": [ "WebhookEndpointDelivery" ], "parameters": [ { "name": "webhookEndpointId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Array of `WebhookDeliveryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookDeliveryResource" } } }, "required": [ "data" ] } } } }, "403": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "" } }, "required": [ "message" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/webhook-endpoints/{webhookEndpointId}/secret": { "post": { "operationId": "v1.webhook-endpoints.secret", "tags": [ "WebhookEndpointSecret" ], "parameters": [ { "name": "webhookEndpointId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`WebhookEndpointResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WebhookEndpointResource" } }, "required": [ "data" ] } } } }, "403": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "" } }, "required": [ "message" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/webhook-endpoints/{webhookEndpointId}/test": { "post": { "operationId": "v1.webhook-endpoints.test", "tags": [ "WebhookEndpointTest" ], "parameters": [ { "name": "webhookEndpointId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "202": { "description": "`WebhookDeliveryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WebhookDeliveryResource" } }, "required": [ "data" ] } } } }, "403": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "" } }, "required": [ "message" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } } }, "components": { "schemas": { "BlockRequest": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z0-9_]+$", "maxLength": 255 }, "html_content": { "type": "string" } }, "required": [ "name", "html_content" ], "title": "BlockRequest" }, "BlockResource": { "type": "object", "properties": { "id": { "type": "integer" }, "uuid": { "type": "string" }, "name": { "type": "string" }, "html_content": { "type": "string" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "uuid", "name", "html_content", "created_at", "updated_at" ], "title": "BlockResource" }, "ContactRequest": { "type": "object", "properties": { "name": { "type": [ "string", "null" ], "maxLength": 255 }, "email": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string", "maxLength": 255 } } }, "title": "ContactRequest" }, "ContactResource": { "type": "object", "properties": { "id": { "type": "integer" }, "uuid": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "email": { "type": "string" }, "extra_attributes": { "type": "array", "items": {} }, "unsubscribed_at": { "type": [ "string", "null" ], "format": "date-time" }, "unsubscribed_by_contact": { "type": "boolean" }, "tags": { "type": "array", "items": { "type": "array", "items": {} } }, "lists": { "type": "array", "items": { "type": "array", "items": {} } }, "topics": { "type": "array", "items": {} }, "sequences": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "status": { "type": "string" } }, "required": [ "id", "name", "status" ] } }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "uuid", "name", "email", "extra_attributes", "unsubscribed_at", "unsubscribed_by_contact", "tags", "lists", "topics", "sequences", "created_at" ], "title": "ContactResource" }, "EmailIdentityResource": { "type": "object", "properties": { "id": { "type": "integer" }, "uuid": { "type": "string" }, "email": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "domain": { "type": [ "string", "null" ] }, "identity_status": { "type": "string" }, "verified_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "uuid", "email", "name", "domain", "identity_status", "verified_at", "created_at", "updated_at" ], "title": "EmailIdentityResource" }, "EmailLogResource": { "type": "object", "properties": { "id": { "type": "integer" }, "provider": { "type": "string" }, "operation": { "type": "string" }, "recipient": { "type": [ "string", "null" ] }, "message_id": { "type": [ "string", "null" ] }, "status": { "type": "string" }, "error": { "type": [ "string", "null" ] }, "request_payload": { "type": [ "array", "null" ], "items": {} }, "response_payload": { "type": [ "array", "null" ], "items": {} }, "sns_payload": { "type": [ "array", "null" ], "items": {} }, "logged_at": { "type": "string", "format": "date-time" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "provider", "operation", "recipient", "message_id", "status", "error", "request_payload", "response_payload", "sns_payload", "logged_at", "created_at" ], "title": "EmailLogResource" }, "EmailTemplateResource": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "html_content": { "type": "string" }, "is_default": { "type": "boolean" }, "archived_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "name", "html_content", "is_default", "archived_at", "created_at", "updated_at" ], "title": "EmailTemplateResource" }, "MailListRequest": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 255 } }, "required": [ "name" ], "title": "MailListRequest" }, "MailListResource": { "type": "object", "properties": { "id": { "type": "integer" }, "uuid": { "type": "string" }, "name": { "type": "string" }, "opt_in_enabled": { "type": "boolean" }, "message": { "type": "object", "properties": { "subject": { "type": [ "string", "null" ] }, "html_content": { "type": [ "string", "null" ] }, "email_identity_id": { "type": [ "integer", "null" ] } }, "required": [ "subject", "html_content", "email_identity_id" ] }, "contacts_count": { "type": "string" }, "topics_count": { "type": "string" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "uuid", "name", "opt_in_enabled", "created_at" ], "title": "MailListResource" }, "NewsletterAbWinnerRequest": { "type": "object", "properties": { "winner_variant": { "type": "string", "enum": [ "a", "b" ] } }, "required": [ "winner_variant" ], "title": "NewsletterAbWinnerRequest" }, "NewsletterContactsPreviewRequest": { "type": "object", "properties": { "filters": { "type": "array", "items": { "type": "object", "properties": { "connector": { "type": "string", "enum": [ "and", "or" ] }, "category": { "type": "string", "enum": [ "attributes", "tags", "lists", "topics", "date", "engagement", "location" ] }, "mode": { "type": "string", "enum": [ "all", "any", "none" ] }, "operator": { "type": "string" }, "field": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } } }, "maxItems": 20 } }, "title": "NewsletterContactsPreviewRequest" }, "NewsletterResource": { "type": "object", "properties": { "id": { "type": "integer" }, "uuid": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "string" }, "subject": { "type": "string" }, "preview_text": { "type": "string" }, "email_identity_id": { "type": "string" }, "email_identity": { "type": [ "array", "null" ], "items": {} }, "email_template_id": { "type": "string" }, "from_email": { "type": "string" }, "from_name": { "type": "string" }, "scheduled_at": { "type": [ "string", "null" ], "format": "date-time" }, "sent_at": { "type": [ "string", "null" ], "format": "date-time" }, "segment_id": { "type": [ "integer", "null" ] }, "filters": { "type": "array", "items": {} }, "content_variables": { "type": "array", "items": {} }, "ab_test_enabled": { "type": "boolean" }, "ab_test_winner_variant": { "type": [ "string", "null" ] }, "subject_b": { "type": "string" }, "preview_text_b": { "type": "string" }, "total_contacts_reached": { "type": "integer" }, "project_ids": { "type": "object", "additionalProperties": {} }, "metrics": { "type": "object", "properties": { "total": { "type": "integer" }, "sent": { "type": "integer" }, "pending": { "type": "integer" }, "opened": { "type": "integer" }, "bounced": { "type": "integer" }, "unsubscribed": { "type": "integer" }, "complained": { "type": "integer" }, "open_rate": { "type": "number" }, "unsubscribe_rate": { "type": "number" } }, "required": [ "total", "sent", "pending", "opened", "bounced", "unsubscribed", "complained", "open_rate", "unsubscribe_rate" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "html_content": { "type": "string" }, "text_content": { "type": "string" }, "html_content_b": { "type": "string" }, "text_content_b": { "type": "string" } }, "required": [ "id", "uuid", "title", "status", "subject", "preview_text", "email_identity_id", "email_identity", "email_template_id", "from_email", "from_name", "scheduled_at", "sent_at", "segment_id", "filters", "content_variables", "ab_test_enabled", "ab_test_winner_variant", "subject_b", "preview_text_b", "total_contacts_reached", "metrics", "created_at", "updated_at", "html_content", "text_content", "html_content_b", "text_content_b" ], "title": "NewsletterResource" }, "ProjectResource": { "type": "object", "properties": { "id": { "type": "integer" }, "uuid": { "type": "string" }, "name": { "type": "string" }, "newsletters_count": { "type": "integer" }, "sequences_count": { "type": "integer" }, "automations_count": { "type": "integer" }, "visual_automations_count": { "type": "integer" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "uuid", "name", "created_at" ], "title": "ProjectResource" }, "SequenceResource": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "status": { "type": "string" }, "contacts_count": { "type": "integer" }, "completed_count": { "type": "integer" }, "active_count": { "anyOf": [ { "type": "null" }, { "type": "object" }, { "type": "integer", "enum": [ 0 ] } ] }, "steps_count": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "steps": { "type": "array", "items": {} }, "segment_id": { "type": [ "integer", "null" ] }, "filters": { "type": "array", "items": {} }, "content_variables": { "type": "array", "items": {} }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "project_ids": { "anyOf": [ { "type": "object", "additionalProperties": {} }, { "type": "object" } ] } }, "required": [ "id", "name", "status", "contacts_count", "completed_count", "active_count", "steps_count", "steps", "segment_id", "filters", "content_variables", "created_at", "project_ids" ] }, { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "status": { "type": "string" }, "steps_count": { "type": "integer" }, "contacts_count": { "type": "integer" }, "completed_count": { "type": "integer" }, "active_count": { "type": [ "object", "null" ] }, "project_ids": { "anyOf": [ { "type": "object", "additionalProperties": {} }, { "type": "object" } ] } }, "required": [ "id", "name", "status", "steps_count", "contacts_count", "completed_count", "active_count", "project_ids" ] } ], "title": "SequenceResource" }, "SequenceStatsResource": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" }, "stats": { "type": "string" }, "mail_metrics": { "type": "string" } }, "required": [ "id", "name", "status", "stats", "mail_metrics" ], "title": "SequenceStatsResource" }, "SequenceStepFiltersRequest": { "type": "object", "properties": { "filters": { "type": "array", "items": { "type": "object", "properties": { "connector": { "type": "string", "enum": [ "and", "or" ] }, "category": { "type": "string", "enum": [ "attributes", "tags", "lists", "topics", "date", "engagement", "location" ] }, "mode": { "type": "string", "enum": [ "all", "any", "none" ] }, "operator": { "type": "string" }, "field": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } } }, "maxItems": 20 } }, "required": [ "filters" ], "title": "SequenceStepFiltersRequest" }, "SequenceStepResource": { "type": "object", "properties": { "id": { "type": "integer" }, "sequence_id": { "type": "integer" }, "delay_days": { "type": "integer" }, "delay_type": { "type": "string" }, "status": { "type": "string" }, "filters": { "type": "array", "items": {} }, "message": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "subject": { "type": [ "string", "null" ] }, "preview_text": { "type": [ "string", "null" ] }, "html_content": { "type": [ "string", "null" ] }, "text_content": { "type": [ "string", "null" ] }, "email_identity_id": { "type": [ "integer", "null" ] }, "email_template_id": { "type": [ "integer", "null" ] }, "template_slot_content": { "type": [ "string", "null" ] }, "email_template": { "type": [ "array", "null" ], "items": {} }, "email_identity": { "type": [ "array", "null" ], "items": {} } }, "required": [ "id", "subject", "preview_text", "html_content", "text_content", "email_identity_id", "email_template_id", "template_slot_content", "email_template", "email_identity" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "sequence_id", "delay_days", "delay_type", "status", "filters", "message", "created_at" ], "title": "SequenceStepResource" }, "SequenceStepStatsResource": { "type": "object", "properties": { "id": { "type": "string" }, "sequence_id": { "type": "string" }, "subject": { "type": "string" }, "delay_days": { "type": "string" }, "delay_type": { "type": "string" }, "status": { "type": "string" }, "stats": { "type": "string" }, "mail_metrics": { "type": "string" } }, "required": [ "id", "sequence_id", "subject", "delay_days", "delay_type", "status", "stats", "mail_metrics" ], "title": "SequenceStepStatsResource" }, "StoreNewsletterRequest": { "type": "object", "properties": { "title": { "type": [ "string", "null" ], "maxLength": 255 }, "subject": { "type": [ "string", "null" ], "maxLength": 255 }, "preview_text": { "type": [ "string", "null" ], "maxLength": 255 }, "html_content": { "type": [ "string", "null" ], "maxLength": 524288 }, "status": { "type": "string", "enum": [ "draft", "live" ] }, "scheduled_at": { "type": [ "string", "null" ], "format": "date-time" }, "email_identity_id": { "type": [ "integer", "null" ] }, "email_template_id": { "type": [ "integer", "null" ] }, "ab_test_enabled": { "type": "boolean" }, "subject_b": { "type": [ "string", "null" ], "maxLength": 255 }, "preview_text_b": { "type": [ "string", "null" ], "maxLength": 255 }, "html_content_b": { "type": [ "string", "null" ], "maxLength": 524288 }, "content_variables": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ], "maxLength": 255 } }, "filters": { "type": "array", "items": { "type": "object", "properties": { "connector": { "type": "string", "enum": [ "and", "or" ] }, "category": { "type": "string", "enum": [ "attributes", "tags", "lists", "topics", "date", "engagement", "location" ] }, "mode": { "type": "string", "enum": [ "all", "any", "none" ] }, "operator": { "type": "string" }, "field": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } } }, "maxItems": 20 }, "project_ids": { "type": "array", "items": { "type": "integer" } } }, "title": "StoreNewsletterRequest" }, "StoreProjectRequest": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 255 } }, "required": [ "name" ], "title": "StoreProjectRequest" }, "StoreWebhookEndpointRequest": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2048 }, "description": { "type": [ "string", "null" ], "maxLength": 255 }, "events": { "type": "array", "items": { "type": "string", "enum": [ "contact.subscribed", "contact.unsubscribed", "contact.resubscribed", "newsletter.sent", "sequence_step.sent", "sequence.completed" ] }, "minItems": 1 } }, "required": [ "url", "events" ], "title": "StoreWebhookEndpointRequest" }, "TagRequest": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 255 } }, "required": [ "name" ], "title": "TagRequest" }, "TagResource": { "type": "object", "properties": { "id": { "type": "integer" }, "uuid": { "type": "string" }, "name": { "type": "string" }, "contacts_count": { "type": "integer" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "uuid", "name", "created_at" ], "title": "TagResource" }, "TopicRequest": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 255 }, "description": { "type": [ "string", "null" ], "maxLength": 1000 } }, "required": [ "name" ], "title": "TopicRequest" }, "TopicResource": { "type": "object", "properties": { "id": { "type": "integer" }, "uuid": { "type": "string" }, "list_id": { "type": "integer" }, "list_name": { "type": "string" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "subscribed_count": { "type": "string" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "uuid", "list_id", "name", "description", "created_at" ], "title": "TopicResource" }, "UpdateNewsletterRequest": { "type": "object", "properties": { "title": { "type": [ "string", "null" ], "maxLength": 255 }, "subject": { "type": [ "string", "null" ], "maxLength": 255 }, "preview_text": { "type": [ "string", "null" ], "maxLength": 255 }, "html_content": { "type": [ "string", "null" ], "maxLength": 524288 }, "status": { "type": "string", "enum": [ "draft", "live" ] }, "scheduled_at": { "type": [ "string", "null" ], "format": "date-time" }, "email_identity_id": { "type": [ "integer", "null" ] }, "email_template_id": { "type": [ "integer", "null" ] }, "ab_test_enabled": { "type": "boolean" }, "subject_b": { "type": [ "string", "null" ], "maxLength": 255 }, "preview_text_b": { "type": [ "string", "null" ], "maxLength": 255 }, "html_content_b": { "type": [ "string", "null" ], "maxLength": 524288 }, "content_variables": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ], "maxLength": 255 } }, "filters": { "type": "array", "items": { "type": "object", "properties": { "connector": { "type": "string", "enum": [ "and", "or" ] }, "category": { "type": "string", "enum": [ "attributes", "tags", "lists", "topics", "date", "engagement", "location" ] }, "mode": { "type": "string", "enum": [ "all", "any", "none" ] }, "operator": { "type": "string" }, "field": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } } }, "maxItems": 20 }, "project_ids": { "type": "array", "items": { "type": "integer" } } }, "title": "UpdateNewsletterRequest" }, "UpdateProjectRequest": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 255 } }, "required": [ "name" ], "title": "UpdateProjectRequest" }, "UpdateWebhookEndpointRequest": { "type": "object", "properties": { "active": { "type": "boolean" }, "description": { "type": [ "string", "null" ], "maxLength": 255 } }, "title": "UpdateWebhookEndpointRequest" }, "WebhookDeliveryResource": { "type": "object", "properties": { "id": { "type": "integer" }, "uuid": { "type": "string" }, "event_type": { "type": "string" }, "status": { "type": "string" }, "attempts": { "type": "integer" }, "response_status": { "type": [ "integer", "null" ] }, "response_body": { "type": [ "string", "null" ] }, "error": { "type": [ "string", "null" ] }, "payload": { "type": "array", "items": {} }, "dispatched_at": { "type": "string" }, "delivered_at": { "type": "string" }, "created_at": { "type": "string" } }, "required": [ "id", "uuid", "event_type", "status", "attempts", "response_status", "response_body", "error", "payload", "dispatched_at", "delivered_at", "created_at" ], "title": "WebhookDeliveryResource" }, "WebhookEndpointResource": { "type": "object", "properties": { "id": { "type": "integer" }, "uuid": { "type": "string" }, "url": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "events": { "type": "array", "items": {} }, "active": { "type": "boolean" }, "disabled_reason": { "type": [ "string", "null" ] }, "consecutive_failures": { "type": "integer" }, "last_triggered_at": { "type": "string" }, "disabled_at": { "type": "string" }, "created_at": { "type": "string" }, "secret": { "type": "string" } }, "required": [ "id", "uuid", "url", "description", "events", "active", "disabled_reason", "consecutive_failures", "last_triggered_at", "disabled_at", "created_at", "secret" ], "title": "WebhookEndpointResource" } }, "responses": { "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" ] } } } }, "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" ] } } } } } } }