{ "openapi": "3.0.4", "info": { "title": "ChatFood API for agents", "description": "Public API v1: the routes reachable with an API token (cf_live_...). Each operation declares the scope it needs in x-required-scope. Guide: /llms-full.txt", "version": "v1" }, "paths": { "/v1/billing/overview": { "get": { "tags": [ "AccountBilling" ], "parameters": [ { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BillingOverviewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BillingOverviewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BillingOverviewModel" } } } } }, "x-required-scope": "billing:read" } }, "/v1/billing/invoices": { "get": { "tags": [ "AccountBilling" ], "parameters": [ { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfBillingInvoicePublicModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfBillingInvoicePublicModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfBillingInvoicePublicModel" } } } } }, "x-required-scope": "billing:read" } }, "/v1/billing/invoices/{invoiceId}": { "get": { "tags": [ "AccountBilling" ], "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BillingInvoicePublicDetailModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BillingInvoicePublicDetailModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BillingInvoicePublicDetailModel" } } } } }, "x-required-scope": "billing:read" } }, "/v1/billing/profile": { "put": { "tags": [ "AccountBilling" ], "parameters": [ { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BillingProfileUpdateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BillingProfileUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BillingProfileUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BillingProfileUpdateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BillingCustomerPublicModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BillingCustomerPublicModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BillingCustomerPublicModel" } } } } }, "x-required-scope": "billing:write" } }, "/v1/billing/usage": { "get": { "tags": [ "AccountBilling" ], "parameters": [ { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "pageIds", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BillingAccountUsageModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BillingAccountUsageModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BillingAccountUsageModel" } } } } }, "x-required-scope": "billing:read" } }, "/v1/accounts/{accountId}/language-slugs": { "get": { "tags": [ "AccountLanguageSlugs" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfLanguageSlugResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfLanguageSlugResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfLanguageSlugResponse" } } } } }, "x-required-scope": "account:read" }, "put": { "tags": [ "AccountLanguageSlugs" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LanguageSlugBatchItem" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LanguageSlugBatchItem" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LanguageSlugBatchItem" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LanguageSlugBatchItem" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BatchWriteResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BatchWriteResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BatchWriteResponse" } } } } }, "x-required-scope": "account:write" }, "delete": { "tags": [ "AccountLanguageSlugs" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "ids", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BatchDeleteResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BatchDeleteResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BatchDeleteResponse" } } } } }, "x-required-scope": "account:write" } }, "/v1/accounts/language-slugs": { "get": { "tags": [ "AccountLanguageSlugs" ], "parameters": [ { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfLanguageSlugResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfLanguageSlugResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfLanguageSlugResponse" } } } } }, "x-required-scope": "account:read" } }, "/v1/accounts/{accountId}/language-slugs/{language}": { "put": { "tags": [ "AccountLanguageSlugs" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "language", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/LanguageSlugRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LanguageSlugRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LanguageSlugRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LanguageSlugRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LanguageSlugResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LanguageSlugResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LanguageSlugResponse" } } } } }, "x-required-scope": "account:write" }, "delete": { "tags": [ "AccountLanguageSlugs" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "language", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } }, "x-required-scope": "account:write" } }, "/v1/accounts/{accountId}/users/notification-lists": { "get": { "tags": [ "AccountNotificationUsers" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "userIds", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfUserNotificationListsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfUserNotificationListsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfUserNotificationListsResponse" } } } } }, "x-required-scope": "account:read" } }, "/v1/accounts/{accountId}/users/{userId}/removal-impact": { "get": { "tags": [ "AccountNotificationUsers" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfNotificationListMembershipResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfNotificationListMembershipResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfNotificationListMembershipResponse" } } } } }, "x-required-scope": "account:read" } }, "/v1/accounts": { "get": { "tags": [ "Accounts" ], "parameters": [ { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfAccountSummaryResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfAccountSummaryResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfAccountSummaryResponse" } } } } }, "x-required-scope": "account:read" } }, "/v1/accounts/{accountId}": { "get": { "tags": [ "Accounts" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountResponse" } } } } }, "x-required-scope": "account:read" }, "patch": { "tags": [ "Accounts" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateAccountRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAccountRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateAccountRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateAccountRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountResponse" } } } } }, "x-required-scope": "account:write" } }, "/v1/accounts/{accountId}/users": { "get": { "tags": [ "Accounts" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfAccountUserResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfAccountUserResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfAccountUserResponse" } } } } }, "x-required-scope": "users:read" } }, "/v1/accounts/{accountId}/utm": { "get": { "tags": [ "AccountUtm" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfChannelUtmResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfChannelUtmResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfChannelUtmResponse" } } } } }, "x-required-scope": "account:read" }, "put": { "tags": [ "AccountUtm" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelUtmBatchItem" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelUtmBatchItem" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelUtmBatchItem" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelUtmBatchItem" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BatchWriteResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BatchWriteResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BatchWriteResponse" } } } } }, "x-required-scope": "account:write" }, "delete": { "tags": [ "AccountUtm" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "ids", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BatchDeleteResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BatchDeleteResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BatchDeleteResponse" } } } } }, "x-required-scope": "account:write" } }, "/v1/accounts/utm": { "get": { "tags": [ "AccountUtm" ], "parameters": [ { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfChannelUtmResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfChannelUtmResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfChannelUtmResponse" } } } } }, "x-required-scope": "account:read" } }, "/v1/accounts/{accountId}/utm/{channel}": { "put": { "tags": [ "AccountUtm" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "channel", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ChannelUtmRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChannelUtmRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChannelUtmRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChannelUtmRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ChannelUtmResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChannelUtmResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChannelUtmResponse" } } } } }, "x-required-scope": "account:write" }, "delete": { "tags": [ "AccountUtm" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "channel", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } }, "x-required-scope": "account:write" } }, "/v1/broadcasts": { "post": { "tags": [ "Broadcasts" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SaveBroadcastRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SaveBroadcastRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaveBroadcastRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SaveBroadcastRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BroadcastResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BroadcastResponse" } } } } }, "x-required-scope": "broadcasts:write" }, "get": { "tags": [ "Broadcasts" ], "parameters": [ { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Status", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BroadcastStatus" } } }, { "name": "PageIds", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "CategoryIds", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "DateFrom", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "DateTo", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "IsFlagged", "in": "query", "schema": { "type": "boolean" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "JourneyId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "HasJourney", "in": "query", "schema": { "type": "boolean" } }, { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BroadcastListPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastListPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BroadcastListPage" } } } } }, "x-required-scope": "broadcasts:read" } }, "/v1/broadcasts/groups": { "get": { "tags": [ "Broadcasts" ], "parameters": [ { "name": "groupBy", "in": "query", "schema": { "type": "string" } }, { "name": "Status", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BroadcastStatus" } } }, { "name": "PageIds", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "CategoryIds", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "DateFrom", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "DateTo", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "IsFlagged", "in": "query", "schema": { "type": "boolean" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "JourneyId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "HasJourney", "in": "query", "schema": { "type": "boolean" } }, { "name": "timezoneOffset", "in": "query", "schema": { "type": "string" } }, { "name": "lookbackHours", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort", "in": "query", "schema": { "type": "string" } }, { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BroadcastGroupsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastGroupsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BroadcastGroupsResponse" } } } } }, "x-required-scope": "broadcasts:read" } }, "/v1/broadcasts/calendar": { "get": { "tags": [ "Broadcasts" ], "parameters": [ { "name": "dateFrom", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "dateTo", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "Status", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BroadcastStatus" } } }, { "name": "PageIds", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "CategoryIds", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "DateFrom", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "DateTo", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "IsFlagged", "in": "query", "schema": { "type": "boolean" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "JourneyId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "HasJourney", "in": "query", "schema": { "type": "boolean" } }, { "name": "groupBy", "in": "query", "schema": { "type": "string", "default": "hour" } }, { "name": "timezoneOffset", "in": "query", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 500 } }, { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BroadcastCalendarResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastCalendarResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BroadcastCalendarResponse" } } } } }, "x-required-scope": "broadcasts:read" } }, "/v1/broadcasts/overview": { "get": { "tags": [ "Broadcasts" ], "parameters": [ { "name": "days", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BroadcastOverviewResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastOverviewResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BroadcastOverviewResponse" } } } } }, "x-required-scope": "broadcasts:read" } }, "/v1/broadcasts/executions": { "get": { "tags": [ "Broadcasts" ], "parameters": [ { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "SchemaId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "BroadcastId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "JourneyId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "HasJourney", "in": "query", "schema": { "type": "boolean" } }, { "name": "PageIds", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "CategoryIds", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "Status", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BroadcastExecutionStatus" } } }, { "name": "ErrorType", "in": "query", "schema": { "type": "string" } }, { "name": "TimeZone", "in": "query", "schema": { "type": "string" } }, { "name": "Country", "in": "query", "schema": { "type": "string" } }, { "name": "DateFrom", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "DateTo", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "HasErrors", "in": "query", "schema": { "type": "boolean" } }, { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BroadcastExecutionPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastExecutionPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BroadcastExecutionPage" } } } } }, "x-required-scope": "broadcasts:read" } }, "/v1/broadcasts/{broadcastId}": { "get": { "tags": [ "Broadcasts" ], "parameters": [ { "name": "broadcastId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BroadcastSummary" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastSummary" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BroadcastSummary" } } } } }, "x-required-scope": "broadcasts:read" }, "put": { "tags": [ "Broadcasts" ], "parameters": [ { "name": "broadcastId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SaveBroadcastRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SaveBroadcastRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaveBroadcastRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SaveBroadcastRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BroadcastResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BroadcastResponse" } } } } }, "x-required-scope": "broadcasts:write" }, "patch": { "tags": [ "Broadcasts" ], "parameters": [ { "name": "broadcastId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateBroadcastRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBroadcastRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateBroadcastRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateBroadcastRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BroadcastResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BroadcastResponse" } } } } }, "x-required-scope": "broadcasts:write" } }, "/v1/broadcasts/{broadcastId}/cancel": { "post": { "tags": [ "Broadcasts" ], "parameters": [ { "name": "broadcastId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BroadcastResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BroadcastResponse" } } } } }, "x-required-scope": "broadcasts:write" } }, "/v1/broadcasts/{broadcastId}/executions": { "get": { "tags": [ "Broadcasts" ], "parameters": [ { "name": "broadcastId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "PageIds", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "CategoryIds", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "Status", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BroadcastExecutionStatus" } } }, { "name": "ErrorType", "in": "query", "schema": { "type": "string" } }, { "name": "TimeZone", "in": "query", "schema": { "type": "string" } }, { "name": "Country", "in": "query", "schema": { "type": "string" } }, { "name": "DateFrom", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "DateTo", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "HasErrors", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BroadcastExecutionPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastExecutionPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BroadcastExecutionPage" } } } } }, "x-required-scope": "broadcasts:read" } }, "/v1/broadcasts/{broadcastId}/executions/{executionId}/cancel": { "post": { "tags": [ "Broadcasts" ], "parameters": [ { "name": "broadcastId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "executionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BroadcastExecutionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastExecutionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BroadcastExecutionResponse" } } } } }, "x-required-scope": "broadcasts:write" } }, "/v1/broadcasts/{broadcastId}/executions/{executionId}/reprocess": { "post": { "tags": [ "Broadcasts" ], "parameters": [ { "name": "broadcastId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "executionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BroadcastExecutionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastExecutionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BroadcastExecutionResponse" } } } } }, "x-required-scope": "broadcasts:write" } }, "/v1/broadcasts/{broadcastId}/executions/cancel": { "post": { "tags": [ "Broadcasts" ], "parameters": [ { "name": "broadcastId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BroadcastExecutionPageRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastExecutionPageRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BroadcastExecutionPageRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BroadcastExecutionPageRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BroadcastExecutionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastExecutionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BroadcastExecutionResponse" } } } } }, "x-required-scope": "broadcasts:write" } }, "/v1/broadcasts/{broadcastId}/executions/reprocess": { "post": { "tags": [ "Broadcasts" ], "parameters": [ { "name": "broadcastId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BroadcastExecutionPageRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastExecutionPageRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BroadcastExecutionPageRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BroadcastExecutionPageRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BroadcastExecutionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastExecutionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BroadcastExecutionResponse" } } } } }, "x-required-scope": "broadcasts:write" } }, "/v1/categories": { "get": { "tags": [ "Categories" ], "parameters": [ { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfCategoryResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfCategoryResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfCategoryResponse" } } } } }, "x-required-scope": "account:read" }, "post": { "tags": [ "Categories" ], "parameters": [ { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateCategoryRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateCategoryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateCategoryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateCategoryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CategoryResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CategoryResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CategoryResponse" } } } } }, "x-required-scope": "account:write" } }, "/v1/categories/{categoryId}": { "get": { "tags": [ "Categories" ], "parameters": [ { "name": "categoryId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CategoryResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CategoryResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CategoryResponse" } } } } }, "x-required-scope": "account:read" }, "patch": { "tags": [ "Categories" ], "parameters": [ { "name": "categoryId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateCategoryRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCategoryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateCategoryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateCategoryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CategoryResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CategoryResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CategoryResponse" } } } } }, "x-required-scope": "account:write" }, "delete": { "tags": [ "Categories" ], "parameters": [ { "name": "categoryId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-required-scope": "account:write" } }, "/v1/categories/{categoryId}/variable-groups": { "get": { "tags": [ "Categories" ], "parameters": [ { "name": "categoryId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfVariableGroupResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfVariableGroupResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfVariableGroupResponse" } } } } }, "x-required-scope": "account:read" }, "post": { "tags": [ "Categories" ], "parameters": [ { "name": "categoryId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateVariableGroupRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateVariableGroupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateVariableGroupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateVariableGroupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/VariableGroupResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/VariableGroupResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VariableGroupResponse" } } } } }, "x-required-scope": "account:write" } }, "/v1/connections": { "get": { "tags": [ "Connections" ], "parameters": [ { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfConnectionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfConnectionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfConnectionResponse" } } } } }, "x-required-scope": "pages:read" } }, "/v1/connections/{connectionId}": { "get": { "tags": [ "Connections" ], "parameters": [ { "name": "connectionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ConnectionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConnectionResponse" } } } } }, "x-required-scope": "pages:read" } }, "/v1/connections/pending-count": { "get": { "tags": [ "Connections" ], "parameters": [ { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PendingConnectionsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PendingConnectionsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PendingConnectionsResponse" } } } } }, "x-required-scope": "pages:read" } }, "/v1/connections/profiles": { "get": { "tags": [ "Connections" ], "parameters": [ { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfConnectionProfileResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfConnectionProfileResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfConnectionProfileResponse" } } } } }, "x-required-scope": "pages:read" } }, "/v1/broadcasts/delivery-preview": { "post": { "tags": [ "DeliveryPreviews" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DeliveryPreviewRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryPreviewRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeliveryPreviewRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeliveryPreviewRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeliveryPreviewResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryPreviewResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeliveryPreviewResponse" } } } } }, "x-required-scope": "broadcasts:read" } }, "/v1/journeys/delivery-preview": { "post": { "tags": [ "DeliveryPreviews" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DeliveryPreviewRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryPreviewRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeliveryPreviewRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeliveryPreviewRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeliveryPreviewResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryPreviewResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeliveryPreviewResponse" } } } } }, "x-required-scope": "journeys:read" } }, "/v1/dynamic-variables": { "get": { "tags": [ "DynamicVariables" ], "parameters": [ { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfDynamicVariableResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfDynamicVariableResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfDynamicVariableResponse" } } } } }, "x-required-scope": "pages:read" } }, "/v1/journeys": { "get": { "tags": [ "Journeys" ], "parameters": [ { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Status", "in": "query", "schema": { "$ref": "#/components/schemas/JourneyStatus" } }, { "name": "PageIds", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "CategoryIds", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfJourneyResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfJourneyResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfJourneyResponse" } } } } }, "x-required-scope": "journeys:read" }, "post": { "tags": [ "Journeys" ], "parameters": [ { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SaveJourneyRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SaveJourneyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaveJourneyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SaveJourneyRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JourneyResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JourneyResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JourneyResponse" } } } } }, "x-required-scope": "journeys:write" } }, "/v1/journeys/{journeyId}": { "get": { "tags": [ "Journeys" ], "parameters": [ { "name": "journeyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JourneyDetailResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JourneyDetailResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JourneyDetailResponse" } } } } }, "x-required-scope": "journeys:read" }, "put": { "tags": [ "Journeys" ], "parameters": [ { "name": "journeyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SaveJourneyRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SaveJourneyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaveJourneyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SaveJourneyRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JourneyResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JourneyResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JourneyResponse" } } } } }, "x-required-scope": "journeys:write" } }, "/v1/journeys/{journeyId}/status": { "patch": { "tags": [ "Journeys" ], "parameters": [ { "name": "journeyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ChangeJourneyStatusRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChangeJourneyStatusRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeJourneyStatusRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChangeJourneyStatusRequest" } } } }, "responses": { "200": { "description": "OK" } }, "x-required-scope": "journeys:write" } }, "/v1/journeys/{journeyId}/copy": { "post": { "tags": [ "Journeys" ], "parameters": [ { "name": "journeyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CopyJourneyRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CopyJourneyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CopyJourneyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CopyJourneyRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JourneyResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JourneyResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JourneyResponse" } } } } }, "x-required-scope": "journeys:write" } }, "/v1/journeys/{journeyId}/leads-count": { "get": { "tags": [ "Journeys" ], "parameters": [ { "name": "journeyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JourneyLeadsCountResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JourneyLeadsCountResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JourneyLeadsCountResponse" } } } } }, "x-required-scope": "journeys:read" } }, "/v1/journeys/{journeyId}/funnel": { "get": { "tags": [ "Journeys" ], "parameters": [ { "name": "journeyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "granularity", "in": "query", "schema": { "type": "string", "default": "step" } }, { "name": "dateFrom", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "dateTo", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "cycle", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JourneyFunnelResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JourneyFunnelResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JourneyFunnelResponse" } } } } }, "x-required-scope": "journeys:read" } }, "/v1/leads": { "get": { "tags": [ "Leads" ], "parameters": [ { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "PageIds", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Provider", "in": "query", "schema": { "$ref": "#/components/schemas/ProviderType" } }, { "name": "Tags", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfLeadResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfLeadResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfLeadResponse" } } } } }, "x-required-scope": "leads:read" } }, "/v1/leads/{leadId}": { "get": { "tags": [ "Leads" ], "parameters": [ { "name": "leadId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LeadResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LeadResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LeadResponse" } } } } }, "x-required-scope": "leads:read" } }, "/v1/me": { "get": { "tags": [ "Me" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MeResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MeResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MeResponse" } } } } }, "x-required-scope": "any" } }, "/v1/uploads": { "post": { "tags": [ "Media" ], "parameters": [ { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateUploadRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateUploadRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateUploadRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateUploadRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UploadResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UploadResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UploadResponse" } } } } }, "x-required-scope": "flows:write" } }, "/v1/voice-messages": { "post": { "tags": [ "Media" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateVoiceMessageRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateVoiceMessageRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateVoiceMessageRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateVoiceMessageRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/VoiceMessageResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/VoiceMessageResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VoiceMessageResponse" } } } } }, "x-required-scope": "flows:write" } }, "/v1/meta/apps": { "get": { "tags": [ "MetaApps" ], "parameters": [ { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Status", "in": "query", "schema": { "$ref": "#/components/schemas/MetaAppStatus" } }, { "name": "HealthStatus", "in": "query", "schema": { "$ref": "#/components/schemas/MetaAppHealthStatus" } }, { "name": "WebhookStatus", "in": "query", "schema": { "$ref": "#/components/schemas/MetaAppWebhookStatus" } }, { "name": "WebhookDrift", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeUsage", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfMetaAppResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfMetaAppResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfMetaAppResponse" } } } } }, "x-required-scope": "account:read" }, "post": { "tags": [ "MetaApps" ], "parameters": [ { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateMetaAppRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateMetaAppRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateMetaAppRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateMetaAppRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MetaAppResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MetaAppResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MetaAppResponse" } } } } }, "x-required-scope": "account:write" } }, "/v1/meta/apps/{appId}": { "get": { "tags": [ "MetaApps" ], "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MetaAppResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MetaAppResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MetaAppResponse" } } } } }, "x-required-scope": "account:read" }, "patch": { "tags": [ "MetaApps" ], "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateMetaAppRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMetaAppRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateMetaAppRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateMetaAppRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MetaAppResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MetaAppResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MetaAppResponse" } } } } }, "x-required-scope": "account:write" }, "delete": { "tags": [ "MetaApps" ], "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-required-scope": "account:write" } }, "/v1/meta/apps/{appId}/webhook": { "post": { "tags": [ "MetaApps" ], "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MetaAppWebhookResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MetaAppWebhookResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MetaAppWebhookResponse" } } } } }, "x-required-scope": "account:write" } }, "/v1/meta/apps/{appId}/health-check": { "post": { "tags": [ "MetaApps" ], "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MetaAppHealthResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MetaAppHealthResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MetaAppHealthResponse" } } } } }, "x-required-scope": "account:write" } }, "/v1/meta/apps/{appId}/pages": { "get": { "tags": [ "MetaApps" ], "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "TokenState", "in": "query", "schema": { "$ref": "#/components/schemas/MetaAppLinkedPageTokenState" } }, { "name": "Status", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PageStatus" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfMetaAppPageResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfMetaAppPageResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfMetaAppPageResponse" } } } } }, "x-required-scope": "account:read" } }, "/v1/meta/datasets": { "get": { "tags": [ "MetaDatasets" ], "parameters": [ { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfMetaDatasetResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfMetaDatasetResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfMetaDatasetResponse" } } } } }, "x-required-scope": "pixels:read" }, "post": { "tags": [ "MetaDatasets" ], "parameters": [ { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateMetaDatasetRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateMetaDatasetRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateMetaDatasetRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateMetaDatasetRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MetaDatasetResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MetaDatasetResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MetaDatasetResponse" } } } } }, "x-required-scope": "pixels:write" } }, "/v1/meta/datasets/{datasetId}": { "get": { "tags": [ "MetaDatasets" ], "parameters": [ { "name": "datasetId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MetaDatasetResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MetaDatasetResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MetaDatasetResponse" } } } } }, "x-required-scope": "pixels:read" }, "patch": { "tags": [ "MetaDatasets" ], "parameters": [ { "name": "datasetId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateMetaDatasetRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMetaDatasetRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateMetaDatasetRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateMetaDatasetRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MetaDatasetResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MetaDatasetResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MetaDatasetResponse" } } } } }, "x-required-scope": "pixels:write" }, "delete": { "tags": [ "MetaDatasets" ], "parameters": [ { "name": "datasetId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-required-scope": "pixels:write" } }, "/v1/meta/pages": { "post": { "tags": [ "MetaPages" ], "parameters": [ { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ConnectMetaPagesRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConnectMetaPagesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConnectMetaPagesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ConnectMetaPagesRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MetaPagesConnectionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MetaPagesConnectionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MetaPagesConnectionResponse" } } } } }, "x-required-scope": "pages:write" } }, "/v1/meta/pages/{pageId}/ice-breakers": { "get": { "tags": [ "MetaPages" ], "parameters": [ { "name": "pageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IceBreakersResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IceBreakersResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IceBreakersResponse" } } } } }, "x-required-scope": "pages:read" }, "put": { "tags": [ "MetaPages" ], "parameters": [ { "name": "pageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/IceBreakerCuration" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IceBreakerCuration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IceBreakerCuration" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IceBreakerCuration" } } } }, "responses": { "200": { "description": "OK" } }, "x-required-scope": "pages:write" } }, "/v1/meta/pages/{pageId}/templates": { "get": { "tags": [ "MetaTemplates" ], "parameters": [ { "name": "pageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Name", "in": "query", "schema": { "type": "string" } }, { "name": "NameOrContent", "in": "query", "schema": { "type": "string" } }, { "name": "Content", "in": "query", "schema": { "type": "string" } }, { "name": "Category", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "Language", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "Status", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfGetTemplateResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfGetTemplateResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfGetTemplateResponse" } } } } }, "x-required-scope": "flows:read" } }, "/v1/meta/template-library": { "get": { "tags": [ "MetaTemplates" ], "parameters": [ { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Platform", "in": "query", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Name", "in": "query", "schema": { "type": "string" } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "Topic", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "Usecase", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "Industry", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "Tags", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "WabaId", "in": "query", "schema": { "type": "string" } }, { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfTemplateLibraryItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfTemplateLibraryItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfTemplateLibraryItem" } } } } }, "x-required-scope": "flows:read" } }, "/v1/notifications/destinations": { "get": { "tags": [ "Notifications" ], "parameters": [ { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfNotificationDestinationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfNotificationDestinationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfNotificationDestinationResponse" } } } } }, "x-required-scope": "account:read" }, "post": { "tags": [ "Notifications" ], "parameters": [ { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateNotificationDestinationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateNotificationDestinationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateNotificationDestinationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateNotificationDestinationRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/NotificationDestinationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NotificationDestinationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NotificationDestinationResponse" } } } } }, "x-required-scope": "account:write" } }, "/v1/notifications/destinations/{destinationId}": { "put": { "tags": [ "Notifications" ], "parameters": [ { "name": "destinationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateNotificationDestinationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateNotificationDestinationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateNotificationDestinationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateNotificationDestinationRequest" } } } }, "responses": { "200": { "description": "OK" } }, "x-required-scope": "account:write" }, "delete": { "tags": [ "Notifications" ], "parameters": [ { "name": "destinationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-required-scope": "account:write" } }, "/v1/notifications/destinations/{destinationId}/recipients": { "put": { "tags": [ "Notifications" ], "parameters": [ { "name": "destinationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NotificationRecipientsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NotificationRecipientsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NotificationRecipientsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NotificationRecipientsRequest" } } } }, "responses": { "200": { "description": "OK" } }, "x-required-scope": "account:write" } }, "/v1/notifications/destinations/{destinationId}/recipients/me": { "delete": { "tags": [ "Notifications" ], "parameters": [ { "name": "destinationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-required-scope": "account:write" } }, "/v1/notifications/recipient-options": { "get": { "tags": [ "Notifications" ], "parameters": [ { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfNotificationRecipientResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfNotificationRecipientResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfNotificationRecipientResponse" } } } } }, "x-required-scope": "account:read" } }, "/v1/notifications/destinations/{destinationId}/recipient-options": { "get": { "tags": [ "Notifications" ], "parameters": [ { "name": "destinationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfNotificationRecipientResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfNotificationRecipientResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfNotificationRecipientResponse" } } } } }, "x-required-scope": "account:read" } }, "/v1/notifications/destinations/{destinationId}/test": { "post": { "tags": [ "Notifications" ], "parameters": [ { "name": "destinationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NotificationTestRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTestRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NotificationTestRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NotificationTestRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/NotificationTestResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTestResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NotificationTestResponse" } } } } }, "x-required-scope": "account:write" } }, "/v1/notifications/destinations/test": { "post": { "tags": [ "Notifications" ], "parameters": [ { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NotificationEndpointTestRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NotificationEndpointTestRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NotificationEndpointTestRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NotificationEndpointTestRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/NotificationTestResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTestResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NotificationTestResponse" } } } } }, "x-required-scope": "account:write" } }, "/v1/notifications/event-types": { "get": { "tags": [ "Notifications" ], "parameters": [ { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfNotificationEventTypeResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfNotificationEventTypeResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfNotificationEventTypeResponse" } } } } }, "x-required-scope": "account:read" } }, "/v1/notifications/subscriptions": { "get": { "tags": [ "Notifications" ], "parameters": [ { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfNotificationSubscriptionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfNotificationSubscriptionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfNotificationSubscriptionResponse" } } } } }, "x-required-scope": "account:read" }, "post": { "tags": [ "Notifications" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NotificationSubscriptionRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NotificationSubscriptionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NotificationSubscriptionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NotificationSubscriptionRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/NotificationSubscriptionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NotificationSubscriptionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NotificationSubscriptionResponse" } } } } }, "x-required-scope": "account:write" } }, "/v1/notifications/subscriptions/{subscriptionId}": { "put": { "tags": [ "Notifications" ], "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NotificationSubscriptionRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NotificationSubscriptionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NotificationSubscriptionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NotificationSubscriptionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/NotificationSubscriptionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NotificationSubscriptionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NotificationSubscriptionResponse" } } } } }, "x-required-scope": "account:write" }, "delete": { "tags": [ "Notifications" ], "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-required-scope": "account:write" } }, "/v1/notifications/deliveries": { "get": { "tags": [ "Notifications" ], "parameters": [ { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfNotificationDeliveryResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfNotificationDeliveryResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfNotificationDeliveryResponse" } } } } }, "x-required-scope": "account:read" } }, "/v1/alerts": { "get": { "tags": [ "PageAlerts" ], "parameters": [ { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Status", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PageIssueStatus" } } }, { "name": "Severity", "in": "query", "schema": { "$ref": "#/components/schemas/PageIssueSeverity" } }, { "name": "Type", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "CategoryIds", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "PageIds", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "ConnectedByIds", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "SearchTerm", "in": "query", "schema": { "type": "string" } }, { "name": "LoggedSince", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "OccurredSince", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AlertListResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AlertListResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AlertListResponse" } } } } }, "x-required-scope": "pages:read" } }, "/v1/alerts/profiles": { "get": { "tags": [ "PageAlerts" ], "parameters": [ { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "severity", "in": "query", "schema": { "$ref": "#/components/schemas/PageIssueSeverity" } }, { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfAlertProfileResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfAlertProfileResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfAlertProfileResponse" } } } } }, "x-required-scope": "pages:read" } }, "/v1/alerts/{alertId}/dismiss": { "post": { "tags": [ "PageAlerts" ], "parameters": [ { "name": "alertId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-required-scope": "pages:write" } }, "/v1/alerts/{alertId}/snooze": { "post": { "tags": [ "PageAlerts" ], "parameters": [ { "name": "alertId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AlertSnoozeRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AlertSnoozeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AlertSnoozeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AlertSnoozeRequest" } } } }, "responses": { "200": { "description": "OK" } }, "x-required-scope": "pages:write" } }, "/v1/alerts/summary": { "get": { "tags": [ "PageAlerts" ], "parameters": [ { "name": "dateFrom", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AlertSummaryResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AlertSummaryResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AlertSummaryResponse" } } } } }, "x-required-scope": "metrics:read" } }, "/v1/pages/{pageId}/meta-apps/{appId}": { "delete": { "tags": [ "PageMetaApps" ], "parameters": [ { "name": "pageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "appId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "uninstallFromUserAccount", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MetaAppDisconnectResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MetaAppDisconnectResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MetaAppDisconnectResponse" } } } } }, "x-required-scope": "account:write" } }, "/v1/pages": { "get": { "tags": [ "Pages" ], "parameters": [ { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "CategoryIds", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "Provider", "in": "query", "schema": { "$ref": "#/components/schemas/ProviderType" } }, { "name": "Statuses", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PageStatus" } } }, { "name": "Countries", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "TimeZone", "in": "query", "schema": { "type": "string" } }, { "name": "IsTokenExpired", "in": "query", "schema": { "type": "boolean" } }, { "name": "IsBlocked", "in": "query", "schema": { "type": "boolean" } }, { "name": "HasRecentLeads", "in": "query", "schema": { "type": "boolean" } }, { "name": "HasBroadcasts", "in": "query", "schema": { "type": "boolean" } }, { "name": "HasSchema", "in": "query", "schema": { "type": "boolean" } }, { "name": "HasOpenIssues", "in": "query", "schema": { "type": "boolean" } }, { "name": "HasLoggedIssues24h", "in": "query", "schema": { "type": "boolean" } }, { "name": "ConnectedByIds", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "ConnectedBy", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "Hosts", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "MetaAppIds", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "UrlHealthStatuses", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UrlHealthStatus" } } }, { "name": "SendsUnhealthyHost", "in": "query", "schema": { "type": "boolean" } }, { "name": "IntegrityStatuses", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "IntegrityViolationTypes", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "schema": { "type": "string" } }, { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfPageResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfPageResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfPageResponse" } } } } }, "x-required-scope": "pages:read" }, "patch": { "tags": [ "Pages" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdatePagesRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePagesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatePagesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatePagesRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PageBatchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PageBatchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PageBatchResult" } } } } }, "x-required-scope": "pages:write" }, "delete": { "tags": [ "Pages" ], "parameters": [ { "name": "ids", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PageBatchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PageBatchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PageBatchResult" } } } } }, "x-required-scope": "pages:write" } }, "/v1/pages/facets": { "get": { "tags": [ "Pages" ], "parameters": [ { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "CategoryIds", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "Provider", "in": "query", "schema": { "$ref": "#/components/schemas/ProviderType" } }, { "name": "Statuses", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PageStatus" } } }, { "name": "Countries", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "TimeZone", "in": "query", "schema": { "type": "string" } }, { "name": "IsTokenExpired", "in": "query", "schema": { "type": "boolean" } }, { "name": "IsBlocked", "in": "query", "schema": { "type": "boolean" } }, { "name": "HasRecentLeads", "in": "query", "schema": { "type": "boolean" } }, { "name": "HasBroadcasts", "in": "query", "schema": { "type": "boolean" } }, { "name": "HasSchema", "in": "query", "schema": { "type": "boolean" } }, { "name": "HasOpenIssues", "in": "query", "schema": { "type": "boolean" } }, { "name": "HasLoggedIssues24h", "in": "query", "schema": { "type": "boolean" } }, { "name": "ConnectedByIds", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "ConnectedBy", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "Hosts", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "MetaAppIds", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "UrlHealthStatuses", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UrlHealthStatus" } } }, { "name": "SendsUnhealthyHost", "in": "query", "schema": { "type": "boolean" } }, { "name": "IntegrityStatuses", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "IntegrityViolationTypes", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PageFacetsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PageFacetsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PageFacetsResponse" } } } } }, "x-required-scope": "pages:read" } }, "/v1/pages/export": { "get": { "tags": [ "Pages" ], "parameters": [ { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "CategoryIds", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "Provider", "in": "query", "schema": { "$ref": "#/components/schemas/ProviderType" } }, { "name": "Statuses", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PageStatus" } } }, { "name": "Countries", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "TimeZone", "in": "query", "schema": { "type": "string" } }, { "name": "IsTokenExpired", "in": "query", "schema": { "type": "boolean" } }, { "name": "IsBlocked", "in": "query", "schema": { "type": "boolean" } }, { "name": "HasRecentLeads", "in": "query", "schema": { "type": "boolean" } }, { "name": "HasBroadcasts", "in": "query", "schema": { "type": "boolean" } }, { "name": "HasSchema", "in": "query", "schema": { "type": "boolean" } }, { "name": "HasOpenIssues", "in": "query", "schema": { "type": "boolean" } }, { "name": "HasLoggedIssues24h", "in": "query", "schema": { "type": "boolean" } }, { "name": "ConnectedByIds", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "ConnectedBy", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "Hosts", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "MetaAppIds", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "UrlHealthStatuses", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UrlHealthStatus" } } }, { "name": "SendsUnhealthyHost", "in": "query", "schema": { "type": "boolean" } }, { "name": "IntegrityStatuses", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "IntegrityViolationTypes", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-required-scope": "pages:read" } }, "/v1/pages/reactivate": { "post": { "tags": [ "Pages" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PageIdsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PageIdsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PageIdsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PageIdsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PageBatchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PageBatchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PageBatchResult" } } } } }, "x-required-scope": "pages:write" } }, "/v1/pages/{pageId}": { "get": { "tags": [ "Pages" ], "parameters": [ { "name": "pageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PageResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PageResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PageResponse" } } } } }, "x-required-scope": "pages:read" }, "patch": { "tags": [ "Pages" ], "parameters": [ { "name": "pageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdatePageRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePageRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatePageRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatePageRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PageResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PageResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PageResponse" } } } } }, "x-required-scope": "pages:write" }, "delete": { "tags": [ "Pages" ], "parameters": [ { "name": "pageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-required-scope": "pages:write" } }, "/v1/pages/{pageId}/reactivate": { "post": { "tags": [ "Pages" ], "parameters": [ { "name": "pageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PageResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PageResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PageResponse" } } } } }, "x-required-scope": "pages:write" } }, "/v1/pages/{pageId}/health": { "get": { "tags": [ "Pages" ], "parameters": [ { "name": "pageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PageHealthResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PageHealthResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PageHealthResponse" } } } } }, "x-required-scope": "pages:read" } }, "/v1/pages/{pageId}/webhook": { "post": { "tags": [ "Pages" ], "parameters": [ { "name": "pageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PageHealthResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PageHealthResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PageHealthResponse" } } } } }, "x-required-scope": "pages:write" } }, "/v1/pages/{pageId}/url-health": { "get": { "tags": [ "Pages" ], "parameters": [ { "name": "pageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfPageUrlHealthResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfPageUrlHealthResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfPageUrlHealthResponse" } } } } }, "x-required-scope": "pages:read" } }, "/v1/pages/{pageId}/integrity": { "get": { "tags": [ "Pages" ], "parameters": [ { "name": "pageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PageIntegrityDetailsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PageIntegrityDetailsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PageIntegrityDetailsResponse" } } } } }, "x-required-scope": "pages:read" } }, "/v1/pages/{pageId}/connections": { "get": { "tags": [ "Pages" ], "parameters": [ { "name": "pageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfConnectionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfConnectionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfConnectionResponse" } } } } }, "x-required-scope": "pages:read" } }, "/v1/pages/{pageId}/leads": { "delete": { "tags": [ "Pages" ], "parameters": [ { "name": "pageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LeadDeletionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LeadDeletionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LeadDeletionResponse" } } } } }, "x-required-scope": "leads:write" } }, "/v1/pages/{pageId}/leads/deletion": { "get": { "tags": [ "Pages" ], "parameters": [ { "name": "pageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LeadDeletionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LeadDeletionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LeadDeletionResponse" } } } } }, "x-required-scope": "leads:read" }, "delete": { "tags": [ "Pages" ], "parameters": [ { "name": "pageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-required-scope": "leads:write" } }, "/v1/pages/{pageId}/inbox-scan": { "post": { "tags": [ "Pages" ], "parameters": [ { "name": "pageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/InboxScanResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InboxScanResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InboxScanResponse" } } } } }, "x-required-scope": "pages:write" }, "get": { "tags": [ "Pages" ], "parameters": [ { "name": "pageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/InboxScanResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InboxScanResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InboxScanResponse" } } } } }, "x-required-scope": "pages:read" } }, "/v1/pages/{pageId}/send-time-suggestion": { "get": { "tags": [ "Pages" ], "parameters": [ { "name": "pageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "days", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SendTimeSuggestionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SendTimeSuggestionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SendTimeSuggestionResponse" } } } } }, "x-required-scope": "metrics:read" } }, "/v1/pages/{pageId}/variables": { "get": { "tags": [ "PageVariables" ], "parameters": [ { "name": "pageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfPageVariableResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfPageVariableResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfPageVariableResponse" } } } } }, "x-required-scope": "pages:read" }, "post": { "tags": [ "PageVariables" ], "parameters": [ { "name": "pageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/VariableRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/VariableRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VariableRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/VariableRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PageVariableResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PageVariableResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PageVariableResponse" } } } } }, "x-required-scope": "pages:write" }, "put": { "tags": [ "PageVariables" ], "parameters": [ { "name": "pageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VariableRequest" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VariableRequest" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VariableRequest" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VariableRequest" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/VariableBatchResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/VariableBatchResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VariableBatchResponse" } } } } }, "x-required-scope": "pages:write" }, "delete": { "tags": [ "PageVariables" ], "parameters": [ { "name": "pageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "ids", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BatchDeleteResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BatchDeleteResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BatchDeleteResponse" } } } } }, "x-required-scope": "pages:write" } }, "/v1/pages/{pageId}/variables/{variableId}": { "patch": { "tags": [ "PageVariables" ], "parameters": [ { "name": "pageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "variableId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateVariableRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVariableRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateVariableRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateVariableRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PageVariableResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PageVariableResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PageVariableResponse" } } } } }, "x-required-scope": "pages:write" }, "delete": { "tags": [ "PageVariables" ], "parameters": [ { "name": "pageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "variableId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-required-scope": "pages:write" } }, "/v1/pages/{pageId}/variables/copy": { "post": { "tags": [ "PageVariables" ], "parameters": [ { "name": "pageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CopyPageVariablesRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CopyPageVariablesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CopyPageVariablesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CopyPageVariablesRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PageVariableCopyResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PageVariableCopyResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PageVariableCopyResponse" } } } } }, "x-required-scope": "pages:write" } }, "/v1/reference/countries": { "get": { "tags": [ "Reference" ], "parameters": [ { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfCountryResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfCountryResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfCountryResponse" } } } } }, "x-required-scope": "any" } }, "/v1/reference/timezones": { "get": { "tags": [ "Reference" ], "parameters": [ { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfTimezoneResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfTimezoneResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfTimezoneResponse" } } } } }, "x-required-scope": "any" } }, "/v1/schemas": { "get": { "tags": [ "Schemas" ], "parameters": [ { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Name", "in": "query", "schema": { "type": "string" } }, { "name": "Status", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SchemaStatusType" } } }, { "name": "PageIds", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "Provider", "in": "query", "schema": { "$ref": "#/components/schemas/ProviderType" } }, { "name": "ChannelTrigger", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelTrigger" } } }, { "name": "CategoryIds", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "includeTotal", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfSchemaResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfSchemaResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfSchemaResponse" } } } } }, "x-required-scope": "flows:read" }, "post": { "tags": [ "Schemas" ], "parameters": [ { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SaveSchemaRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SaveSchemaRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaveSchemaRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SaveSchemaRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SchemaResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SchemaResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SchemaResponse" } } } } }, "x-required-scope": "flows:write" } }, "/v1/schemas/category-counts": { "get": { "tags": [ "Schemas" ], "parameters": [ { "name": "Name", "in": "query", "schema": { "type": "string" } }, { "name": "Status", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SchemaStatusType" } } }, { "name": "PageIds", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "Provider", "in": "query", "schema": { "$ref": "#/components/schemas/ProviderType" } }, { "name": "ChannelTrigger", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelTrigger" } } }, { "name": "CategoryIds", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfSchemaCategoryCountResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfSchemaCategoryCountResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfSchemaCategoryCountResponse" } } } } }, "x-required-scope": "flows:read" } }, "/v1/schemas/{schemaId}": { "get": { "tags": [ "Schemas" ], "parameters": [ { "name": "schemaId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SchemaResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SchemaResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SchemaResponse" } } } } }, "x-required-scope": "flows:read" }, "put": { "tags": [ "Schemas" ], "parameters": [ { "name": "schemaId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SaveSchemaRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SaveSchemaRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaveSchemaRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SaveSchemaRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SchemaResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SchemaResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SchemaResponse" } } } } }, "x-required-scope": "flows:write" }, "patch": { "tags": [ "Schemas" ], "parameters": [ { "name": "schemaId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateSchemaRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSchemaRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateSchemaRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateSchemaRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SchemaResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SchemaResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SchemaResponse" } } } } }, "x-required-scope": "flows:write" }, "delete": { "tags": [ "Schemas" ], "parameters": [ { "name": "schemaId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-required-scope": "flows:write" } }, "/v1/schemas/{schemaId}/copy": { "post": { "tags": [ "Schemas" ], "parameters": [ { "name": "schemaId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CopySchemaRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CopySchemaRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CopySchemaRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CopySchemaRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SchemaResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SchemaResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SchemaResponse" } } } } }, "x-required-scope": "flows:write" } }, "/v1/schemas/validate-variables": { "post": { "tags": [ "Schemas" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ValidateSchemaVariablesRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidateSchemaVariablesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidateSchemaVariablesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ValidateSchemaVariablesRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SchemaVariableValidationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SchemaVariableValidationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SchemaVariableValidationResponse" } } } } }, "x-required-scope": "flows:read" } }, "/v1/schemas/{schemaId}/metrics": { "get": { "tags": [ "Schemas" ], "parameters": [ { "name": "schemaId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "broadcastId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SchemaMetricsReport" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SchemaMetricsReport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SchemaMetricsReport" } } } } }, "x-required-scope": "metrics:read" } }, "/v1/schemas/{schemaId}/metrics/broadcasts": { "get": { "tags": [ "Schemas" ], "parameters": [ { "name": "schemaId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfSchemaBroadcastMetricsSummary" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfSchemaBroadcastMetricsSummary" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfSchemaBroadcastMetricsSummary" } } } } }, "x-required-scope": "metrics:read" } }, "/v1/schemas/{schemaId}/route-weight-suggestion": { "get": { "tags": [ "Schemas" ], "parameters": [ { "name": "schemaId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfRouteWeightSuggestion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfRouteWeightSuggestion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfRouteWeightSuggestion" } } } } }, "x-required-scope": "flows:read" } }, "/v1/schemas/{schemaId}/utility-templates": { "get": { "tags": [ "Schemas" ], "parameters": [ { "name": "schemaId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfTemplateInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfTemplateInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfTemplateInfo" } } } } }, "x-required-scope": "flows:read" } }, "/v1/schemas/{schemaId}/test": { "post": { "tags": [ "Schemas" ], "parameters": [ { "name": "schemaId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/TestSchemaRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TestSchemaRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TestSchemaRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TestSchemaRequest" } } } }, "responses": { "200": { "description": "OK" } }, "x-required-scope": "flows:write" } }, "/v1/tags": { "get": { "tags": [ "Tags" ], "parameters": [ { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfTagResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfTagResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfTagResponse" } } } } }, "x-required-scope": "leads:read" }, "post": { "tags": [ "Tags" ], "parameters": [ { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateTagRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateTagRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateTagRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateTagRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TagResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TagResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TagResponse" } } } } }, "x-required-scope": "leads:write" } }, "/v1/telegram/pages": { "post": { "tags": [ "TelegramPages" ], "parameters": [ { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ConnectTelegramPageRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConnectTelegramPageRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConnectTelegramPageRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ConnectTelegramPageRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TelegramPageResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TelegramPageResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TelegramPageResponse" } } } } }, "x-required-scope": "pages:write" } }, "/v1/telegram/pages/{pageId}": { "delete": { "tags": [ "TelegramPages" ], "parameters": [ { "name": "pageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-required-scope": "pages:write" } }, "/v1/telegram/pages/{pageId}/presentation": { "get": { "tags": [ "TelegramPages" ], "parameters": [ { "name": "pageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TelegramBotPresentation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TelegramBotPresentation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TelegramBotPresentation" } } } } }, "x-required-scope": "pages:read" }, "put": { "tags": [ "TelegramPages" ], "parameters": [ { "name": "pageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/TelegramBotPresentation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TelegramBotPresentation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TelegramBotPresentation" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TelegramBotPresentation" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TelegramBotPresentation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TelegramBotPresentation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TelegramBotPresentation" } } } } }, "x-required-scope": "pages:write" } }, "/v1/telegram/pages/{pageId}/channels": { "get": { "tags": [ "TelegramPages" ], "parameters": [ { "name": "pageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfTelegramChannelResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfTelegramChannelResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfTelegramChannelResponse" } } } } }, "x-required-scope": "pages:read" } }, "/v1/utility-templates/{templateId}/retry": { "post": { "tags": [ "UtilityTemplates" ], "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RetryUtilityTemplateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RetryUtilityTemplateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RetryUtilityTemplateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RetryUtilityTemplateRequest" } } } }, "responses": { "200": { "description": "OK" } }, "x-required-scope": "flows:write" } }, "/v1/utility-templates/retry": { "post": { "tags": [ "UtilityTemplates" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RetryUtilityTemplatesRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RetryUtilityTemplatesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RetryUtilityTemplatesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RetryUtilityTemplatesRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RetryQueuedResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RetryQueuedResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RetryQueuedResponse" } } } } }, "x-required-scope": "flows:write" } }, "/v1/variable-groups/{groupId}": { "get": { "tags": [ "VariableGroups" ], "parameters": [ { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/VariableGroupDetailResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/VariableGroupDetailResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VariableGroupDetailResponse" } } } } }, "x-required-scope": "account:read" }, "patch": { "tags": [ "VariableGroups" ], "parameters": [ { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateVariableGroupRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVariableGroupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateVariableGroupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateVariableGroupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/VariableGroupDetailResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/VariableGroupDetailResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VariableGroupDetailResponse" } } } } }, "x-required-scope": "account:write" }, "delete": { "tags": [ "VariableGroups" ], "parameters": [ { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-required-scope": "account:write" } }, "/v1/variable-groups/{groupId}/duplicate": { "post": { "tags": [ "VariableGroups" ], "parameters": [ { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DuplicateVariableGroupRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DuplicateVariableGroupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DuplicateVariableGroupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DuplicateVariableGroupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/VariableGroupDetailResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/VariableGroupDetailResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VariableGroupDetailResponse" } } } } }, "x-required-scope": "account:write" } }, "/v1/variable-groups/{groupId}/variables": { "get": { "tags": [ "VariableGroups" ], "parameters": [ { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfCategoryVariableResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfCategoryVariableResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfCategoryVariableResponse" } } } } }, "x-required-scope": "account:read" }, "post": { "tags": [ "VariableGroups" ], "parameters": [ { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/VariableRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/VariableRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VariableRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/VariableRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CategoryVariableResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CategoryVariableResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CategoryVariableResponse" } } } } }, "x-required-scope": "account:write" }, "put": { "tags": [ "VariableGroups" ], "parameters": [ { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VariableRequest" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VariableRequest" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VariableRequest" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VariableRequest" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/VariableBatchResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/VariableBatchResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VariableBatchResponse" } } } } }, "x-required-scope": "account:write" }, "delete": { "tags": [ "VariableGroups" ], "parameters": [ { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "ids", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BatchDeleteResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BatchDeleteResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BatchDeleteResponse" } } } } }, "x-required-scope": "account:write" } }, "/v1/variable-groups/{groupId}/variables/{variableId}": { "patch": { "tags": [ "VariableGroups" ], "parameters": [ { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "variableId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateVariableRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVariableRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateVariableRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateVariableRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CategoryVariableResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CategoryVariableResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CategoryVariableResponse" } } } } }, "x-required-scope": "account:write" }, "delete": { "tags": [ "VariableGroups" ], "parameters": [ { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "variableId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-required-scope": "account:write" } }, "/v1/website-domains": { "get": { "tags": [ "WebsiteDomains" ], "parameters": [ { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfWebsiteDomainResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfWebsiteDomainResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfWebsiteDomainResponse" } } } } }, "x-required-scope": "websites:read" }, "post": { "tags": [ "WebsiteDomains" ], "parameters": [ { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/WebsiteDomainRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WebsiteDomainRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebsiteDomainRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WebsiteDomainRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WebsiteDomainResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WebsiteDomainResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebsiteDomainResponse" } } } } }, "x-required-scope": "websites:write" } }, "/v1/website-domains/{domainId}": { "get": { "tags": [ "WebsiteDomains" ], "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WebsiteDomainResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WebsiteDomainResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebsiteDomainResponse" } } } } }, "x-required-scope": "websites:read" }, "put": { "tags": [ "WebsiteDomains" ], "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/WebsiteDomainRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WebsiteDomainRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebsiteDomainRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WebsiteDomainRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WebsiteDomainResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WebsiteDomainResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebsiteDomainResponse" } } } } }, "x-required-scope": "websites:write" }, "delete": { "tags": [ "WebsiteDomains" ], "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-required-scope": "websites:write" } }, "/v1/website-domains/{domainId}/slugs": { "get": { "tags": [ "WebsiteDomains" ], "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfWebsiteDomainSlugResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfWebsiteDomainSlugResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfWebsiteDomainSlugResponse" } } } } }, "x-required-scope": "websites:read" }, "put": { "tags": [ "WebsiteDomains" ], "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WebsiteDomainSlugRequest" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WebsiteDomainSlugRequest" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WebsiteDomainSlugRequest" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WebsiteDomainSlugRequest" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WebsiteDomainSlugResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WebsiteDomainSlugResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WebsiteDomainSlugResponse" } } } } } }, "x-required-scope": "websites:write" }, "delete": { "tags": [ "WebsiteDomains" ], "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "ids", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BatchDeleteResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BatchDeleteResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BatchDeleteResponse" } } } } }, "x-required-scope": "websites:write" } }, "/v1/website-domains/{domainId}/websites": { "get": { "tags": [ "WebsiteDomains" ], "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CursorPageOfWebsiteResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfWebsiteResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfWebsiteResponse" } } } } }, "x-required-scope": "websites:read" }, "post": { "tags": [ "WebsiteDomains" ], "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/WebsiteRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WebsiteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebsiteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WebsiteRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WebsiteResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WebsiteResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebsiteResponse" } } } } }, "x-required-scope": "websites:write" } }, "/v1/website-domains/validate-script": { "post": { "tags": [ "WebsiteDomains" ], "parameters": [ { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ValidateWebsiteScriptRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidateWebsiteScriptRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidateWebsiteScriptRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ValidateWebsiteScriptRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WebsiteScriptValidationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WebsiteScriptValidationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebsiteScriptValidationResponse" } } } } }, "x-required-scope": "websites:read" } }, "/v1/websites/{websiteId}": { "get": { "tags": [ "Websites" ], "parameters": [ { "name": "websiteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WebsiteResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WebsiteResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebsiteResponse" } } } } }, "x-required-scope": "websites:read" }, "put": { "tags": [ "Websites" ], "parameters": [ { "name": "websiteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/WebsiteRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WebsiteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebsiteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WebsiteRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WebsiteResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WebsiteResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebsiteResponse" } } } } }, "x-required-scope": "websites:write" }, "delete": { "tags": [ "Websites" ], "parameters": [ { "name": "websiteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-required-scope": "websites:write" } } }, "components": { "schemas": { "AccountResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "pictureUrl": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "AccountStatus": { "enum": [ 0, 1, -1 ], "type": "integer", "format": "int32" }, "AccountSummaryResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "pictureUrl": { "type": "string", "nullable": true }, "pageCount": { "type": "integer", "format": "int32" }, "userCount": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "AccountUserResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "pictureUrl": { "type": "string", "nullable": true }, "isOwner": { "type": "boolean" } }, "additionalProperties": false }, "AlertCountsResponse": { "type": "object", "properties": { "criticalCount": { "type": "integer", "format": "int32" }, "warningCount": { "type": "integer", "format": "int32" }, "broadcastErrorCount": { "type": "integer", "format": "int64" }, "loggedCount": { "type": "integer", "format": "int32" }, "loggedPageCount": { "type": "integer", "format": "int32" }, "pagesWithIssuesCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AlertIssueResponse": { "type": "object", "properties": { "alertId": { "type": "string", "format": "uuid" }, "tokenId": { "type": "string", "format": "uuid", "nullable": true }, "metaAppId": { "type": "string", "format": "uuid", "nullable": true }, "metaAppName": { "type": "string", "nullable": true }, "appId": { "type": "string", "nullable": true }, "scope": { "type": "string", "nullable": true }, "type": { "type": "integer", "format": "int32" }, "status": { "type": "integer", "format": "int32" }, "severity": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "errorCode": { "type": "integer", "format": "int32", "nullable": true }, "errorSubcode": { "type": "integer", "format": "int32", "nullable": true }, "occurrenceCount": { "type": "integer", "format": "int32" }, "firstOccurrenceAt": { "type": "string", "format": "date-time" }, "lastOccurrenceAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "AlertListResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PageAlertResponse" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int32" }, "pageCount": { "type": "integer", "format": "int32" }, "typeCounts": { "type": "array", "items": { "$ref": "#/components/schemas/AlertTypeCountResponse" }, "nullable": true } }, "additionalProperties": false }, "AlertProfileResponse": { "type": "object", "properties": { "facebookAccountId": { "type": "string", "nullable": true }, "facebookAccountName": { "type": "string", "nullable": true }, "appCount": { "type": "integer", "format": "int32" }, "pageCount": { "type": "integer", "format": "int32" }, "issueCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AlertSnoozeRequest": { "type": "object", "properties": { "until": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "AlertSummaryResponse": { "type": "object", "properties": { "alerts": { "$ref": "#/components/schemas/AlertCountsResponse" }, "pages": { "$ref": "#/components/schemas/PageHealthCountsResponse" }, "lastCheckedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "AlertTypeCountResponse": { "type": "object", "properties": { "type": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ApiTokenResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "prefix": { "type": "string", "nullable": true }, "accountId": { "type": "string", "format": "uuid", "nullable": true }, "scopes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "expiresAt": { "type": "string", "format": "date-time", "nullable": true }, "lastUsedAt": { "type": "string", "format": "date-time", "nullable": true }, "lastUsedIp": { "type": "string", "nullable": true }, "revokedAt": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "isActive": { "type": "boolean" } }, "additionalProperties": false }, "AuditedBy": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "date": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "BatchDeleteResponse": { "type": "object", "properties": { "deleted": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BatchWriteResponse": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BillingAccountUsageModel": { "type": "object", "properties": { "accountId": { "type": "string", "format": "uuid" }, "from": { "type": "string", "format": "date" }, "to": { "type": "string", "format": "date" }, "totals": { "$ref": "#/components/schemas/BillingUsageMetrics" }, "pages": { "type": "array", "items": { "$ref": "#/components/schemas/BillingUsageRow" }, "nullable": true }, "days": { "type": "array", "items": { "$ref": "#/components/schemas/BillingUsageDayModel" }, "nullable": true }, "catalogue": { "type": "array", "items": { "$ref": "#/components/schemas/BillingUsageTypeModel" }, "nullable": true } }, "additionalProperties": false }, "BillingBasis": { "enum": [ "ActiveLeadsEndOfPeriod", "ActiveLeadsPeak", "UniqueLeadsReached", "NewLeads" ], "type": "string" }, "BillingCustomerPublicModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "companyId": { "type": "string", "format": "uuid", "nullable": true }, "accountId": { "type": "string", "format": "uuid", "nullable": true }, "planId": { "type": "string", "format": "uuid" }, "planName": { "type": "string", "nullable": true }, "ownerName": { "type": "string", "nullable": true }, "isCompany": { "type": "boolean" }, "status": { "$ref": "#/components/schemas/BillingCustomerStatus" }, "trialEndsAt": { "type": "string", "format": "date-time", "nullable": true }, "billingEmail": { "type": "string", "nullable": true }, "legalName": { "type": "string", "nullable": true }, "taxId": { "type": "string", "nullable": true }, "preferredMethod": { "$ref": "#/components/schemas/BillingPaymentMethod" }, "pixDiscountBps": { "type": "integer", "format": "int32", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "BillingCustomerStatus": { "enum": [ "Trial", "Active", "PastDue", "Suspended", "Cancelled" ], "type": "string" }, "BillingInvoicePublicDetailModel": { "type": "object", "properties": { "invoice": { "$ref": "#/components/schemas/BillingInvoicePublicModel" }, "customer": { "$ref": "#/components/schemas/BillingCustomerPublicModel" }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/BillingUsageLinePublicModel" }, "nullable": true } }, "additionalProperties": false }, "BillingInvoicePublicModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "number": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/BillingInvoiceStatus" }, "periodStart": { "type": "string", "format": "date" }, "periodEnd": { "type": "string", "format": "date" }, "basis": { "$ref": "#/components/schemas/BillingBasis" }, "issuedAt": { "type": "string", "format": "date-time" }, "dueAt": { "type": "string", "format": "date-time" }, "subtotalCents": { "type": "integer", "format": "int64" }, "discountCents": { "type": "integer", "format": "int64" }, "adjustmentCents": { "type": "integer", "format": "int64" }, "amountCents": { "type": "integer", "format": "int64" }, "pixDiscountBps": { "type": "integer", "format": "int32" }, "amountPixCents": { "type": "integer", "format": "int64" }, "trial": { "type": "boolean" }, "paidAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "BillingInvoiceStatus": { "enum": [ "Open", "Paid", "PastDue", "Void", "Waived" ], "type": "string" }, "BillingOverrideKind": { "enum": [ "PercentDiscount", "FixedUnitPrice", "FixedTotal", "Free" ], "type": "string" }, "BillingOverrideScope": { "enum": [ "Company", "Account", "Page" ], "type": "string" }, "BillingOverviewModel": { "type": "object", "properties": { "customer": { "$ref": "#/components/schemas/BillingCustomerPublicModel" }, "plan": { "$ref": "#/components/schemas/BillingPlanPublicModel" }, "estimate": { "$ref": "#/components/schemas/BillingPreviewModel" }, "recentInvoices": { "type": "array", "items": { "$ref": "#/components/schemas/BillingInvoicePublicModel" }, "nullable": true } }, "additionalProperties": false }, "BillingPaymentMethod": { "enum": [ "Ask", "Card", "Pix" ], "type": "string" }, "BillingPlanPublicModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "currency": { "type": "string", "nullable": true }, "basis": { "$ref": "#/components/schemas/BillingBasis" }, "pricingMode": { "$ref": "#/components/schemas/BillingPricingMode" }, "unitPrice": { "type": "number", "format": "double" }, "tiers": { "type": "array", "items": { "$ref": "#/components/schemas/BillingTier" }, "nullable": true }, "flatAmountCents": { "type": "integer", "format": "int64" }, "minimumCents": { "type": "integer", "format": "int64" }, "includedUnits": { "type": "integer", "format": "int64" }, "pixDiscountBps": { "type": "integer", "format": "int32" }, "dueDays": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BillingPreviewLineModel": { "type": "object", "properties": { "pageId": { "type": "string", "format": "uuid" }, "pageName": { "type": "string", "nullable": true }, "accountId": { "type": "string", "format": "uuid", "nullable": true }, "accountName": { "type": "string", "nullable": true }, "quantity": { "type": "number", "format": "double" }, "billableQuantity": { "type": "number", "format": "double" }, "baseUnitPrice": { "type": "number", "format": "double" }, "unitPrice": { "type": "number", "format": "double" }, "overrideKind": { "$ref": "#/components/schemas/BillingOverrideKind" }, "overrideScope": { "$ref": "#/components/schemas/BillingOverrideScope" }, "baseAmountCents": { "type": "integer", "format": "int64" }, "amountCents": { "type": "integer", "format": "int64" }, "unmeasured": { "type": "boolean" } }, "additionalProperties": false }, "BillingPreviewModel": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid" }, "customerName": { "type": "string", "nullable": true }, "planId": { "type": "string", "format": "uuid" }, "planName": { "type": "string", "nullable": true }, "basis": { "$ref": "#/components/schemas/BillingBasis" }, "periodStart": { "type": "string", "format": "date" }, "periodEnd": { "type": "string", "format": "date" }, "measuredThrough": { "type": "string", "format": "date" }, "totalQuantity": { "type": "number", "format": "double" }, "subtotalCents": { "type": "integer", "format": "int64" }, "discountCents": { "type": "integer", "format": "int64" }, "adjustmentCents": { "type": "integer", "format": "int64" }, "totalCents": { "type": "integer", "format": "int64" }, "pixDiscountBps": { "type": "integer", "format": "int32" }, "amountPixCents": { "type": "integer", "format": "int64" }, "trial": { "type": "boolean" }, "fixedTotal": { "type": "boolean" }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/BillingPreviewLineModel" }, "nullable": true } }, "additionalProperties": false }, "BillingPricingMode": { "enum": [ "PerUnit", "Graduated", "Flat" ], "type": "string" }, "BillingProfileUpdateRequest": { "type": "object", "properties": { "billingEmail": { "type": "string", "nullable": true }, "legalName": { "type": "string", "nullable": true }, "taxId": { "type": "string", "nullable": true }, "preferredMethod": { "$ref": "#/components/schemas/BillingPaymentMethod" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "BillingTier": { "type": "object", "properties": { "upTo": { "type": "integer", "format": "int64", "nullable": true }, "unitPrice": { "type": "number", "format": "double" } }, "additionalProperties": false }, "BillingUsageDayModel": { "type": "object", "properties": { "pageId": { "type": "string", "format": "uuid" }, "day": { "type": "string", "format": "date" }, "type": { "type": "string", "nullable": true }, "value": { "type": "number", "format": "double" } }, "additionalProperties": false }, "BillingUsageLinePublicModel": { "type": "object", "properties": { "pageId": { "type": "string", "format": "uuid" }, "pageName": { "type": "string", "nullable": true }, "accountId": { "type": "string", "format": "uuid", "nullable": true }, "accountName": { "type": "string", "nullable": true }, "quantity": { "type": "number", "format": "double" }, "billableQuantity": { "type": "number", "format": "double" }, "unmeasured": { "type": "boolean" }, "unitPrice": { "type": "number", "format": "double" }, "overrideKind": { "$ref": "#/components/schemas/BillingOverrideKind" }, "amountCents": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "BillingUsageMetrics": { "type": "object", "properties": { "pages": { "type": "integer", "format": "int64" }, "presenceDays": { "type": "integer", "format": "int64" }, "activeLeads": { "type": "number", "format": "double" }, "activeLeadsPeak": { "type": "number", "format": "double" }, "activeLeadsDays": { "type": "integer", "format": "int64" }, "totalLeads": { "type": "number", "format": "double" }, "blockedLeads": { "type": "number", "format": "double" }, "deletedLeads": { "type": "number", "format": "double" }, "unsubscribedLeads": { "type": "number", "format": "double" }, "newLeads": { "type": "number", "format": "double" }, "broadcastExecutions": { "type": "number", "format": "double" }, "broadcastLeadsSent": { "type": "number", "format": "double" }, "uniqueLeadsReachedMonth": { "type": "number", "format": "double" }, "uniqueLeadsReachedMeasuredPages": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "BillingUsageRow": { "type": "object", "properties": { "groupId": { "type": "string", "format": "uuid" }, "groupKind": { "type": "string", "nullable": true }, "groupName": { "type": "string", "nullable": true }, "companyId": { "type": "string", "format": "uuid", "nullable": true }, "companyName": { "type": "string", "nullable": true }, "accountId": { "type": "string", "format": "uuid", "nullable": true }, "accountName": { "type": "string", "nullable": true }, "metrics": { "$ref": "#/components/schemas/BillingUsageMetrics" } }, "additionalProperties": false }, "BillingUsageTypeModel": { "type": "object", "properties": { "type": { "type": "integer", "format": "int32" }, "key": { "type": "string", "nullable": true }, "aggregation": { "type": "string", "nullable": true }, "confidence": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BroadcastAuthor": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "date": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "BroadcastCalendarResponse": { "type": "object", "properties": { "groups": { "type": "array", "items": { "$ref": "#/components/schemas/BroadcastTimeGroup" }, "nullable": true } }, "additionalProperties": false }, "BroadcastCategoryCount": { "type": "object", "properties": { "categoryId": { "type": "string", "format": "uuid", "nullable": true }, "categoryName": { "type": "string", "nullable": true }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BroadcastChannelTargetItem": { "type": "object", "properties": { "pageId": { "type": "string", "format": "uuid" }, "includeProfiles": { "type": "boolean" }, "channelReferenceIds": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "BroadcastCounts": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64" }, "scheduled": { "type": "integer", "format": "int64" }, "inProgress": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "BroadcastDeliveryIntelligence": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "unreadThreshold": { "type": "integer", "format": "int32" }, "reactivationDays": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BroadcastExecutionCounts": { "type": "object", "properties": { "success": { "type": "integer", "format": "int64" }, "inProgress": { "type": "integer", "format": "int64" }, "withErrors": { "type": "integer", "format": "int64" }, "blocked": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "BroadcastExecutionError": { "type": "object", "properties": { "errorType": { "type": "string", "nullable": true }, "errorMessage": { "type": "string", "nullable": true }, "count": { "type": "integer", "format": "int32" }, "lastOccurrence": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "BroadcastExecutionItem": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "broadcastId": { "type": "string", "format": "uuid" }, "schemaId": { "type": "string", "format": "uuid" }, "flowName": { "type": "string", "nullable": true }, "broadcastType": { "$ref": "#/components/schemas/BroadcastType" }, "broadcastStatus": { "$ref": "#/components/schemas/BroadcastStatus" }, "broadcastScheduledTo": { "type": "string", "format": "date-time", "nullable": true }, "broadcastStartedAt": { "type": "string", "format": "date-time", "nullable": true }, "broadcastCreatedAt": { "type": "string", "format": "date-time", "nullable": true }, "pageId": { "type": "string", "format": "uuid" }, "pageName": { "type": "string", "nullable": true }, "pageReferenceId": { "type": "string", "nullable": true }, "pageTimeZone": { "type": "string", "nullable": true }, "pageCountryCode": { "type": "string", "nullable": true }, "categoryId": { "type": "string", "nullable": true }, "journeyId": { "type": "string", "format": "uuid", "nullable": true }, "status": { "$ref": "#/components/schemas/BroadcastExecutionStatus" }, "total": { "type": "integer", "format": "int64" }, "successCount": { "type": "integer", "format": "int64" }, "failureCount": { "type": "integer", "format": "int64" }, "pendingCount": { "type": "integer", "format": "int64" }, "sent": { "type": "integer", "format": "int64" }, "executedAt": { "type": "string", "format": "date-time", "nullable": true }, "scheduledTo": { "type": "string", "format": "date-time", "nullable": true }, "isBlocked": { "type": "boolean" }, "blockedReason": { "type": "string", "nullable": true }, "errorMessage": { "type": "string", "nullable": true }, "errorCount": { "type": "integer", "format": "int64" }, "topError": { "$ref": "#/components/schemas/BroadcastExecutionError" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/BroadcastExecutionError" }, "nullable": true }, "pageRestrictions": { "type": "array", "items": { "$ref": "#/components/schemas/BroadcastPageRestrictionItem" }, "nullable": true } }, "additionalProperties": false }, "BroadcastExecutionPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/BroadcastExecutionItem" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "BroadcastExecutionPageRequest": { "type": "object", "properties": { "pageId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "BroadcastExecutionResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "broadcastId": { "type": "string", "format": "uuid" }, "pageId": { "type": "string", "format": "uuid" }, "scheduledTo": { "type": "string", "format": "date-time", "nullable": true }, "timeZone": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64" }, "successCount": { "type": "integer", "format": "int64" }, "failureCount": { "type": "integer", "format": "int64" }, "pendingCount": { "type": "integer", "format": "int64" }, "engagementSkippedCount": { "type": "integer", "format": "int64", "nullable": true }, "executedAt": { "type": "string", "format": "date-time" }, "status": { "$ref": "#/components/schemas/BroadcastExecutionStatus" }, "errorMessage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BroadcastExecutionStatus": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8 ], "type": "integer", "format": "int32" }, "BroadcastExecutionTotals": { "type": "object", "properties": { "totalExecutions": { "type": "integer", "format": "int32" }, "totalProfiles": { "type": "integer", "format": "int64" }, "totalSuccess": { "type": "integer", "format": "int64" }, "totalFailure": { "type": "integer", "format": "int64" }, "totalPending": { "type": "integer", "format": "int64" }, "byStatus": { "type": "array", "items": { "$ref": "#/components/schemas/BroadcastStatusCount" }, "nullable": true }, "executionsSuccess": { "type": "integer", "format": "int32" }, "executionsInProgress": { "type": "integer", "format": "int32" }, "executionsWithErrors": { "type": "integer", "format": "int32" }, "executionsBlocked": { "type": "integer", "format": "int32" }, "totalSent": { "type": "integer", "format": "int64" }, "totalErrored": { "type": "integer", "format": "int64" }, "totalDelivery": { "type": "integer", "format": "int64" }, "totalRead": { "type": "integer", "format": "int64" }, "totalProfileBlocked": { "type": "integer", "format": "int64" }, "flaggedExecutionsCount": { "type": "integer", "format": "int32" }, "hasFlaggedExecutions": { "type": "boolean" } }, "additionalProperties": false }, "BroadcastGroupsResponse": { "type": "object", "properties": { "groups": { "type": "array", "items": { "$ref": "#/components/schemas/BroadcastTimeGroup" }, "nullable": true }, "total": { "type": "integer", "format": "int64" }, "hasMore": { "type": "boolean" } }, "additionalProperties": false }, "BroadcastLeadCounts": { "type": "object", "properties": { "planned": { "type": "integer", "format": "int64" }, "success": { "type": "integer", "format": "int64" }, "sent": { "type": "integer", "format": "int64" }, "errors": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "BroadcastLeadOutcomes": { "type": "object", "properties": { "sent": { "type": "integer", "format": "int64" }, "delivered": { "type": "integer", "format": "int64" }, "read": { "type": "integer", "format": "int64" }, "clicked": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "BroadcastListPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/BroadcastSummary" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64" }, "categoryCounts": { "type": "array", "items": { "$ref": "#/components/schemas/BroadcastCategoryCount" }, "nullable": true } }, "additionalProperties": false }, "BroadcastMessageTag": { "enum": [ 1, 2, 3, 4, 5, 6 ], "type": "integer", "format": "int32" }, "BroadcastMetricTotals": { "type": "object", "properties": { "totalMessagesReceived": { "type": "integer", "format": "int64" }, "totalMessagesSent": { "type": "integer", "format": "int64" }, "totalMessagesErrored": { "type": "integer", "format": "int64" }, "totalMessagesDelivered": { "type": "integer", "format": "int64" }, "totalProfilesBlocked": { "type": "integer", "format": "int64" }, "totalProfilesDeleted": { "type": "integer", "format": "int64" }, "totalProfilesUnsubscribed": { "type": "integer", "format": "int64" }, "totalPageBlocked": { "type": "integer", "format": "int64" }, "deliveryRate": { "type": "number", "format": "double" }, "errorRate": { "type": "number", "format": "double" }, "lastUpdatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "BroadcastOutcomeFreshness": { "type": "object", "properties": { "source": { "$ref": "#/components/schemas/MessageOutcomeSource" }, "pendingUntil": { "type": "string", "format": "date-time", "nullable": true }, "coveredFrom": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "BroadcastOverviewResponse": { "type": "object", "properties": { "broadcasts": { "$ref": "#/components/schemas/BroadcastCounts" }, "executions": { "$ref": "#/components/schemas/BroadcastExecutionCounts" }, "leads": { "$ref": "#/components/schemas/BroadcastLeadCounts" } }, "additionalProperties": false }, "BroadcastPageRef": { "type": "object", "properties": { "pageId": { "type": "string", "format": "uuid" }, "pageReferenceId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "categoryId": { "type": "string", "format": "uuid", "nullable": true }, "categoryName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BroadcastPageRestrictionItem": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/PageIssueType" }, "severity": { "$ref": "#/components/schemas/PageIssueSeverity" }, "message": { "type": "string", "nullable": true }, "startedAt": { "type": "string", "format": "date-time" }, "lastOccurrenceAt": { "type": "string", "format": "date-time" }, "resolvedAt": { "type": "string", "format": "date-time", "nullable": true }, "endedAt": { "type": "string", "format": "date-time", "nullable": true }, "isOpen": { "type": "boolean" }, "occurrenceCount": { "type": "integer", "format": "int32" }, "errorCode": { "type": "integer", "format": "int32", "nullable": true }, "errorSubcode": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "BroadcastRecencyFilter": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "format": "int32" }, "BroadcastResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "$ref": "#/components/schemas/BroadcastStatus" }, "schemaId": { "type": "string", "format": "uuid" }, "pageIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "type": { "$ref": "#/components/schemas/BroadcastType" }, "topicName": { "type": "string", "nullable": true }, "messageTag": { "$ref": "#/components/schemas/BroadcastMessageTag" }, "recencyFilter": { "$ref": "#/components/schemas/BroadcastRecencyFilter" }, "recencyBasis": { "$ref": "#/components/schemas/RecencyBasis" }, "recencyOlderThanHours": { "type": "integer", "format": "int32", "nullable": true }, "recencyNewerThanHours": { "type": "integer", "format": "int32", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "tagMatchMode": { "$ref": "#/components/schemas/TagMatchMode" }, "deliveryIntelligence": { "$ref": "#/components/schemas/BroadcastDeliveryIntelligence" }, "notificationType": { "$ref": "#/components/schemas/NotificationType" }, "onlySubscribers": { "type": "boolean" }, "subscriptionTag": { "type": "string", "nullable": true }, "scheduledTo": { "type": "string", "format": "date-time", "nullable": true }, "isImmediate": { "type": "boolean" }, "channelTargets": { "type": "array", "items": { "$ref": "#/components/schemas/BroadcastChannelTargetItem" }, "nullable": true }, "skippedPageIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "createdBy": { "$ref": "#/components/schemas/BroadcastAuthor" }, "updatedBy": { "$ref": "#/components/schemas/BroadcastAuthor" }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "BroadcastStatus": { "enum": [ 1, 2, 3, 4, 5, 6 ], "type": "integer", "format": "int32" }, "BroadcastStatusCount": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/BroadcastExecutionStatus" }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BroadcastSummary": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "schemaId": { "type": "string", "format": "uuid" }, "schemaName": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/BroadcastStatus" }, "type": { "$ref": "#/components/schemas/BroadcastType" }, "notificationType": { "$ref": "#/components/schemas/NotificationType" }, "topicName": { "type": "string", "nullable": true }, "messageTag": { "$ref": "#/components/schemas/BroadcastMessageTag" }, "recencyFilter": { "$ref": "#/components/schemas/BroadcastRecencyFilter" }, "recencyBasis": { "$ref": "#/components/schemas/RecencyBasis" }, "recencyOlderThanHours": { "type": "integer", "format": "int32", "nullable": true }, "recencyNewerThanHours": { "type": "integer", "format": "int32", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "tagMatchMode": { "$ref": "#/components/schemas/TagMatchMode" }, "scheduledTo": { "type": "string", "format": "date-time", "nullable": true }, "createdBy": { "$ref": "#/components/schemas/BroadcastAuthor" }, "createdAt": { "type": "string", "format": "date-time" }, "executionSummary": { "$ref": "#/components/schemas/BroadcastExecutionTotals" }, "totalPages": { "type": "integer", "format": "int32" }, "pages": { "type": "array", "items": { "$ref": "#/components/schemas/BroadcastPageRef" }, "nullable": true }, "categories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "metricsSummary": { "$ref": "#/components/schemas/BroadcastMetricTotals" }, "journeyId": { "type": "string", "format": "uuid", "nullable": true }, "journeyStepIndex": { "type": "integer", "format": "int32", "nullable": true }, "journeyStepId": { "type": "string", "format": "uuid", "nullable": true }, "journeyLoopCount": { "type": "integer", "format": "int32", "nullable": true }, "outcomes": { "$ref": "#/components/schemas/BroadcastOutcomeFreshness" }, "leadOutcomes": { "$ref": "#/components/schemas/BroadcastLeadOutcomes" } }, "additionalProperties": false }, "BroadcastTimeGroup": { "type": "object", "properties": { "date": { "type": "string", "nullable": true }, "hour": { "type": "integer", "format": "int32" }, "categoryId": { "type": "string", "format": "uuid", "nullable": true }, "categoryName": { "type": "string", "nullable": true }, "count": { "type": "integer", "format": "int32" }, "broadcasts": { "type": "array", "items": { "$ref": "#/components/schemas/BroadcastSummary" }, "nullable": true } }, "additionalProperties": false }, "BroadcastType": { "enum": [ 1, 2, 3, 4, 5, 6 ], "type": "integer", "format": "int32" }, "Button": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "phone_number": { "type": "string", "nullable": true }, "example": { "type": "array", "items": { "type": "string" }, "nullable": true }, "payload": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CategoryFacetModel": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CategoryResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "format": "uuid" }, "pageCount": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "CategoryVariableResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "groupId": { "type": "string", "format": "uuid" }, "key": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "dynamicValue": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/VariableType" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "ChangeJourneyStatusRequest": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/JourneyStatus" } }, "additionalProperties": false }, "ChannelTrigger": { "enum": [ 0, 1, 2, 3, 4, 5, -1 ], "type": "integer", "format": "int32" }, "ChannelUtmBatchItem": { "type": "object", "properties": { "channel": { "type": "string", "nullable": true }, "utmSource": { "type": "string", "nullable": true }, "campaignEnabled": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "ChannelUtmRequest": { "type": "object", "properties": { "utmSource": { "type": "string", "nullable": true }, "campaignEnabled": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "ChannelUtmResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "channel": { "type": "string", "nullable": true }, "utmSource": { "type": "string", "nullable": true }, "campaignEnabled": { "type": "boolean", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "ConnectMetaPagesRequest": { "type": "object", "properties": { "facebookId": { "type": "string", "nullable": true }, "userAccessToken": { "type": "string", "nullable": true }, "metaAppId": { "type": "string", "format": "uuid" }, "facebookAccountName": { "type": "string", "nullable": true }, "permissions": { "type": "string", "nullable": true }, "deletePreviousToken": { "type": "boolean" }, "deletePreviousApp": { "type": "boolean" } }, "additionalProperties": false }, "ConnectTelegramPageRequest": { "type": "object", "properties": { "botToken": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ConnectedAppModel": { "type": "object", "properties": { "metaAppId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "appId": { "type": "string", "nullable": true }, "channel": { "$ref": "#/components/schemas/TokenChannel" }, "status": { "$ref": "#/components/schemas/TokenStatus" }, "connectedAt": { "type": "string", "format": "date-time" }, "connectedByName": { "type": "string", "nullable": true }, "connectedById": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ConnectedProfileModel": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "hasActiveToken": { "type": "boolean" } }, "additionalProperties": false }, "ConnectionActionType": { "enum": [ 1, 2, 3, 4, 5, 6 ], "type": "integer", "format": "int32" }, "ConnectionPageResponse": { "type": "object", "properties": { "pageId": { "type": "string", "format": "uuid" }, "pageName": { "type": "string", "nullable": true }, "pageReferenceId": { "type": "string", "nullable": true }, "action": { "$ref": "#/components/schemas/ConnectionActionType" }, "actionLabel": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ConnectionProfileResponse": { "type": "object", "properties": { "facebookAccountId": { "type": "string", "nullable": true }, "facebookAccountIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "facebookAccountName": { "type": "string", "nullable": true }, "pageCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ConnectionResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "$ref": "#/components/schemas/ConnectionStatus" }, "statusLabel": { "type": "string", "nullable": true }, "errorMessage": { "type": "string", "nullable": true }, "facebookAccountId": { "type": "string", "nullable": true }, "facebookAccountName": { "type": "string", "nullable": true }, "permissions": { "type": "string", "nullable": true }, "metaAppId": { "type": "string", "format": "uuid", "nullable": true }, "metaAppName": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "format": "uuid" }, "createdByName": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "pages": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionPageResponse" }, "nullable": true } }, "additionalProperties": false }, "ConnectionStatus": { "enum": [ 0, 1, 2, -1 ], "type": "integer", "format": "int32" }, "ConversationSettings": { "type": "object", "properties": { "whenUnmatched": { "$ref": "#/components/schemas/UnmatchedSettings" }, "whenFinished": { "$ref": "#/components/schemas/UnmatchedSettings" }, "whenAlreadyScheduled": { "type": "string", "nullable": true }, "escapeKeywords": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "CopyJourneyRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "copyAudience": { "type": "boolean" }, "copySteps": { "type": "boolean" } }, "additionalProperties": false }, "CopyPageVariablesRequest": { "type": "object", "properties": { "sourcePageId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "CopySchemaRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "copyPages": { "type": "boolean" }, "copyFlow": { "type": "boolean" } }, "additionalProperties": false }, "CountryResponse": { "type": "object", "properties": { "code": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "flag": { "type": "string", "nullable": true }, "timezones": { "type": "array", "items": { "type": "string" }, "nullable": true }, "primaryTimezone": { "type": "string", "nullable": true }, "currencies": { "type": "array", "items": { "type": "string" }, "nullable": true }, "languages": { "type": "array", "items": { "type": "string" }, "nullable": true }, "region": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateCategoryRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateMetaAppRequest": { "type": "object", "properties": { "appId": { "type": "string", "nullable": true }, "secret": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "isDefault": { "type": "boolean" }, "extraScopes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "scope": { "$ref": "#/components/schemas/MetaAppScope" }, "companyId": { "type": "string", "format": "uuid", "nullable": true }, "accountIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "CreateMetaDatasetRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "metaDatasetId": { "type": "string", "nullable": true }, "accessToken": { "type": "string", "nullable": true }, "testEventCode": { "type": "string", "nullable": true }, "websiteEventName": { "type": "string", "nullable": true }, "messagingEventName": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "appliesToAllPages": { "type": "boolean" }, "categoryIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "CreateNotificationDestinationRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "maxLength": 120, "minLength": 1, "type": "string" }, "kind": { "$ref": "#/components/schemas/NotificationChannelKind" }, "endpoint": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "recipientUserIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "CreateTagRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateUploadRequest": { "type": "object", "properties": { "folder": { "type": "string", "nullable": true }, "extension": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateVariableGroupRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateVoiceMessageRequest": { "type": "object", "properties": { "url": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CursorPageOfAccountSummaryResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AccountSummaryResponse" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CursorPageOfAccountUserResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AccountUserResponse" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CursorPageOfAlertProfileResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AlertProfileResponse" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CursorPageOfBillingInvoicePublicModel": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/BillingInvoicePublicModel" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CursorPageOfCategoryResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryResponse" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CursorPageOfCategoryVariableResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryVariableResponse" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CursorPageOfChannelUtmResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelUtmResponse" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CursorPageOfConnectionProfileResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionProfileResponse" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CursorPageOfConnectionResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionResponse" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CursorPageOfCountryResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CountryResponse" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CursorPageOfDynamicVariableResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/DynamicVariableResponse" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CursorPageOfGetTemplateResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/GetTemplateResponse" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CursorPageOfJourneyResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/JourneyResponse" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CursorPageOfLanguageSlugResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/LanguageSlugResponse" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CursorPageOfLeadResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/LeadResponse" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CursorPageOfMetaAppPageResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/MetaAppPageResponse" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CursorPageOfMetaAppResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/MetaAppResponse" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CursorPageOfMetaDatasetResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/MetaDatasetResponse" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CursorPageOfNotificationDeliveryResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationDeliveryResponse" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CursorPageOfNotificationDestinationResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationDestinationResponse" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CursorPageOfNotificationEventTypeResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationEventTypeResponse" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CursorPageOfNotificationListMembershipResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationListMembershipResponse" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CursorPageOfNotificationRecipientResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationRecipientResponse" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CursorPageOfNotificationSubscriptionResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationSubscriptionResponse" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CursorPageOfPageResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PageResponse" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CursorPageOfPageUrlHealthResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PageUrlHealthResponse" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CursorPageOfPageVariableResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PageVariableResponse" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CursorPageOfRouteWeightSuggestion": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/RouteWeightSuggestion" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CursorPageOfSchemaBroadcastMetricsSummary": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SchemaBroadcastMetricsSummary" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CursorPageOfSchemaCategoryCountResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SchemaCategoryCountResponse" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CursorPageOfSchemaResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SchemaResponse" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CursorPageOfTagResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/TagResponse" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CursorPageOfTelegramChannelResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/TelegramChannelResponse" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CursorPageOfTemplateInfo": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateInfo" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CursorPageOfTemplateLibraryItem": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateLibraryItem" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CursorPageOfTimezoneResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/TimezoneResponse" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CursorPageOfUserNotificationListsResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserNotificationListsResponse" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CursorPageOfVariableGroupResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/VariableGroupResponse" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CursorPageOfWebsiteDomainResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/WebsiteDomainResponse" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CursorPageOfWebsiteDomainSlugResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/WebsiteDomainSlugResponse" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CursorPageOfWebsiteResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/WebsiteResponse" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "DeleteAllProfilesJobStatus": { "enum": [ 0, 1, 2, 3, 4, -1 ], "type": "integer", "format": "int32" }, "DeliveryPagePreview": { "type": "object", "properties": { "pageId": { "type": "string", "format": "uuid" }, "activeLeads": { "type": "integer", "format": "int64" }, "skipped": { "type": "integer", "format": "int64" }, "applies": { "type": "boolean" } }, "additionalProperties": false }, "DeliveryPreviewRequest": { "type": "object", "properties": { "pageIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "policy": { "$ref": "#/components/schemas/DeliveryRuleSettings" } }, "additionalProperties": false }, "DeliveryPreviewResponse": { "type": "object", "properties": { "activeLeads": { "type": "integer", "format": "int64" }, "skipped": { "type": "integer", "format": "int64" }, "pages": { "type": "array", "items": { "$ref": "#/components/schemas/DeliveryPagePreview" }, "nullable": true }, "skippedPageIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "DeliveryRuleSettings": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "unreadThreshold": { "type": "integer", "format": "int32" }, "reactivationDays": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DuplicateVariableGroupRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DynamicVariableResponse": { "type": "object", "properties": { "value": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FacetCountModel": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetTemplateResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "category": { "type": "string", "nullable": true }, "rejected_reason": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "components": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateComponent" }, "nullable": true } }, "additionalProperties": false }, "IceBreakerCuration": { "type": "object", "properties": { "configured": { "type": "boolean" }, "entries": { "type": "array", "items": { "$ref": "#/components/schemas/IceBreakerCurationEntry" }, "nullable": true } }, "additionalProperties": false }, "IceBreakerCurationEntry": { "type": "object", "properties": { "keyword": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IceBreakerItem": { "type": "object", "properties": { "question": { "type": "string", "nullable": true }, "keyword": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IceBreakerPoolItem": { "type": "object", "properties": { "keyword": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "schemaUpdatedAt": { "type": "string", "format": "date-time" }, "position": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "IceBreakersResponse": { "type": "object", "properties": { "pool": { "type": "array", "items": { "$ref": "#/components/schemas/IceBreakerPoolItem" }, "nullable": true }, "curation": { "$ref": "#/components/schemas/IceBreakerCuration" }, "effective": { "type": "array", "items": { "$ref": "#/components/schemas/IceBreakerItem" }, "nullable": true } }, "additionalProperties": false }, "InboxScanJobStatus": { "enum": [ 0, 1, 2, 3, -1 ], "type": "integer", "format": "int32" }, "InboxScanResponse": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/InboxScanJobStatus" }, "leadsFound": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "JourneyDetailResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/JourneyStatus" }, "mode": { "$ref": "#/components/schemas/JourneyMode" }, "repeatFromStart": { "type": "boolean" }, "cycleGapHours": { "type": "integer", "format": "int32", "nullable": true }, "entryDelayHours": { "type": "integer", "format": "int32", "nullable": true }, "provider": { "$ref": "#/components/schemas/ProviderType" }, "pages": { "type": "array", "items": { "$ref": "#/components/schemas/JourneyPageReference" }, "nullable": true }, "categoryIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "dynamicUpdate": { "type": "boolean", "nullable": true }, "categories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "totalPages": { "type": "integer", "format": "int32" }, "skippedPageIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "steps": { "type": "array", "items": { "$ref": "#/components/schemas/JourneyStepDefinition" }, "nullable": true }, "deliveryIntelligence": { "$ref": "#/components/schemas/DeliveryRuleSettings" }, "anchorDate": { "type": "string", "format": "date-time", "nullable": true }, "currentStepIndex": { "type": "integer", "format": "int32" }, "loopCount": { "type": "integer", "format": "int32" }, "version": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" }, "createdByUser": { "$ref": "#/components/schemas/AuditedBy" }, "updatedByUser": { "$ref": "#/components/schemas/AuditedBy" }, "schemas": { "type": "array", "items": { "$ref": "#/components/schemas/JourneySchemaLabel" }, "nullable": true } }, "additionalProperties": false }, "JourneyFunnelResponse": { "type": "object", "properties": { "journeyId": { "type": "string", "format": "uuid" }, "granularity": { "type": "string", "nullable": true }, "totalEnrolled": { "type": "integer", "format": "int64" }, "totalSent": { "type": "integer", "format": "int64" }, "cycle": { "type": "integer", "format": "int32", "nullable": true }, "availableCycles": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "buckets": { "type": "array", "items": { "$ref": "#/components/schemas/JourneyFunnelStage" }, "nullable": true }, "outcomes": { "$ref": "#/components/schemas/OutcomeFreshness" } }, "additionalProperties": false }, "JourneyFunnelStage": { "type": "object", "properties": { "key": { "type": "integer", "format": "int32" }, "label": { "type": "string", "nullable": true }, "recipients": { "type": "integer", "format": "int64" }, "sent": { "type": "integer", "format": "int64" }, "delivered": { "type": "integer", "format": "int64" }, "read": { "type": "integer", "format": "int64" }, "errored": { "type": "integer", "format": "int64" }, "failed": { "type": "integer", "format": "int64" }, "leads": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "JourneyLeadsCountResponse": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "JourneyMode": { "enum": [ 1, 2, 3 ], "type": "integer", "format": "int32" }, "JourneyPageReference": { "type": "object", "properties": { "referenceId": { "type": "string", "nullable": true }, "providerId": { "$ref": "#/components/schemas/ProviderType" }, "categoryId": { "type": "string", "format": "uuid", "nullable": true }, "status": { "$ref": "#/components/schemas/PageStatus" }, "language": { "type": "string", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "accountId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "JourneyResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/JourneyStatus" }, "mode": { "$ref": "#/components/schemas/JourneyMode" }, "repeatFromStart": { "type": "boolean" }, "cycleGapHours": { "type": "integer", "format": "int32", "nullable": true }, "entryDelayHours": { "type": "integer", "format": "int32", "nullable": true }, "provider": { "$ref": "#/components/schemas/ProviderType" }, "pages": { "type": "array", "items": { "$ref": "#/components/schemas/JourneyPageReference" }, "nullable": true }, "categoryIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "dynamicUpdate": { "type": "boolean", "nullable": true }, "categories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "totalPages": { "type": "integer", "format": "int32" }, "skippedPageIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "steps": { "type": "array", "items": { "$ref": "#/components/schemas/JourneyStepDefinition" }, "nullable": true }, "deliveryIntelligence": { "$ref": "#/components/schemas/DeliveryRuleSettings" }, "anchorDate": { "type": "string", "format": "date-time", "nullable": true }, "currentStepIndex": { "type": "integer", "format": "int32" }, "loopCount": { "type": "integer", "format": "int32" }, "version": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" }, "createdByUser": { "$ref": "#/components/schemas/AuditedBy" }, "updatedByUser": { "$ref": "#/components/schemas/AuditedBy" } }, "additionalProperties": false }, "JourneySchemaLabel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/SchemaStatusType" } }, "additionalProperties": false }, "JourneyStatus": { "enum": [ 1, 2, 3, 4, 5 ], "type": "integer", "format": "int32" }, "JourneyStepDefinition": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "index": { "type": "integer", "format": "int32" }, "dayOffset": { "type": "integer", "format": "int32" }, "timeOfDay": { "type": "string", "nullable": true }, "schemaIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "selectionMode": { "$ref": "#/components/schemas/JourneyStepSelectionMode" }, "schemaWeights": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "broadcastType": { "$ref": "#/components/schemas/BroadcastType" }, "messageTag": { "$ref": "#/components/schemas/BroadcastMessageTag" }, "notificationType": { "$ref": "#/components/schemas/NotificationType" } }, "additionalProperties": false }, "JourneyStepSelectionMode": { "enum": [ 1, 2 ], "type": "integer", "format": "int32" }, "LanguageSlugBatchItem": { "type": "object", "properties": { "language": { "type": "string", "nullable": true }, "slug": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LanguageSlugRequest": { "type": "object", "properties": { "slug": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LanguageSlugResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "language": { "type": "string", "nullable": true }, "slug": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "LeadDeletionResponse": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/DeleteAllProfilesJobStatus" }, "profilesDeleted": { "type": "integer", "format": "int64" }, "totalProfiles": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "LeadResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "surname": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "pictureUrl": { "type": "string", "nullable": true }, "pageId": { "type": "string", "format": "uuid" }, "pageName": { "type": "string", "nullable": true }, "accountId": { "type": "string", "format": "uuid" }, "provider": { "$ref": "#/components/schemas/ProviderType" }, "externalId": { "type": "string", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "tagEvents": { "type": "array", "items": { "$ref": "#/components/schemas/LeadTagEvent" }, "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "LeadTagEvent": { "type": "object", "properties": { "tag": { "type": "string", "nullable": true }, "action": { "$ref": "#/components/schemas/TagEventAction" }, "occurredAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "MeAccount": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/AccountStatus" }, "permissions": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "MeResponse": { "type": "object", "properties": { "authenticationMethod": { "type": "string", "nullable": true }, "user": { "$ref": "#/components/schemas/MeUser" }, "accounts": { "type": "array", "items": { "$ref": "#/components/schemas/MeAccount" }, "nullable": true }, "token": { "$ref": "#/components/schemas/ApiTokenResponse" } }, "additionalProperties": false }, "MeUser": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MessageOutcomeSource": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "MetaAppDisconnectResponse": { "type": "object", "properties": { "unsubscribed": { "type": "boolean" }, "unsubscribeError": { "type": "string", "nullable": true }, "appUninstalled": { "type": "boolean" }, "uninstallError": { "type": "string", "nullable": true }, "uninstallErrorCode": { "type": "integer", "format": "int32", "nullable": true }, "uninstallSkippedReason": { "type": "string", "nullable": true }, "tokensDiscarded": { "type": "integer", "format": "int32" }, "unlinked": { "type": "boolean" }, "cascadeDisconnectedPages": { "type": "array", "items": { "$ref": "#/components/schemas/MetaAppDisconnectedPage" }, "nullable": true } }, "additionalProperties": false }, "MetaAppDisconnectedPage": { "type": "object", "properties": { "pageId": { "type": "string", "format": "uuid" }, "pageName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MetaAppHealthResponse": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/MetaAppHealthStatus" }, "skipped": { "type": "boolean" }, "webhookDrift": { "type": "boolean" }, "errorCode": { "type": "integer", "format": "int32", "nullable": true }, "error": { "type": "string", "nullable": true }, "appUsagePercent": { "type": "integer", "format": "int32", "nullable": true }, "recordedStatus": { "$ref": "#/components/schemas/MetaAppHealthStatus" }, "recordedWebhookDrift": { "type": "boolean" }, "checkedAt": { "type": "string", "format": "date-time", "nullable": true }, "changedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "MetaAppHealthStatus": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "format": "int32" }, "MetaAppLinkedPageTokenState": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32" }, "MetaAppPageResponse": { "type": "object", "properties": { "pageId": { "type": "string", "format": "uuid" }, "pageName": { "type": "string", "nullable": true }, "pageReferenceId": { "type": "string", "nullable": true }, "pageStatus": { "$ref": "#/components/schemas/PageStatus" }, "hasAccessToken": { "type": "boolean" }, "tokenStatus": { "$ref": "#/components/schemas/TokenStatus" }, "connectedAt": { "type": "string", "format": "date-time" }, "tier": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MetaAppResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "appId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/MetaAppStatus" }, "isDefault": { "type": "boolean" }, "scope": { "$ref": "#/components/schemas/MetaAppScope" }, "companyId": { "type": "string", "format": "uuid", "nullable": true }, "accountIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "accountNames": { "type": "array", "items": { "type": "string" }, "nullable": true }, "extraScopes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "webhookStatus": { "$ref": "#/components/schemas/MetaAppWebhookStatus" }, "webhookSubscribedAt": { "type": "string", "format": "date-time", "nullable": true }, "webhookDrift": { "type": "boolean" }, "healthStatus": { "$ref": "#/components/schemas/MetaAppHealthStatus" }, "healthCheckedAt": { "type": "string", "format": "date-time", "nullable": true }, "healthChangedAt": { "type": "string", "format": "date-time", "nullable": true }, "healthVerdictIsStale": { "type": "boolean" }, "usage": { "$ref": "#/components/schemas/MetaAppUsageResponse" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "MetaAppScope": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "MetaAppStatus": { "enum": [ 0, 1, -1 ], "type": "integer", "format": "int32" }, "MetaAppUsageResponse": { "type": "object", "properties": { "pagesLinked": { "type": "integer", "format": "int32" }, "pagesUsable": { "type": "integer", "format": "int32" }, "pagesRetiredTier": { "type": "integer", "format": "int32" }, "pagesExclusivelyDependent": { "type": "integer", "format": "int32" }, "tokensActive": { "type": "integer", "format": "int32" }, "tokensBroken": { "type": "integer", "format": "int32" }, "cooldownSecondsByScope": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "nullable": true }, "unreachableReason": { "type": "string", "nullable": true }, "appUsagePercent": { "type": "integer", "format": "int32", "nullable": true }, "appUsageAt": { "type": "string", "format": "date-time", "nullable": true }, "usageReadingIsStale": { "type": "boolean" } }, "additionalProperties": false }, "MetaAppWebhookResponse": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/MetaAppWebhookStatus" }, "succeeded": { "type": "boolean" }, "skipped": { "type": "boolean" }, "callbackUrl": { "type": "string", "nullable": true }, "fields": { "type": "array", "items": { "type": "string" }, "nullable": true }, "subscribedAt": { "type": "string", "format": "date-time", "nullable": true }, "error": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MetaAppWebhookStatus": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "MetaDatasetResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "metaDatasetId": { "type": "string", "nullable": true }, "hasAccessToken": { "type": "boolean" }, "testEventCode": { "type": "string", "nullable": true }, "websiteEventName": { "type": "string", "nullable": true }, "messagingEventName": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "appliesToAllPages": { "type": "boolean" }, "categoryIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "MetaPagesConnectionResponse": { "type": "object", "properties": { "connectionId": { "type": "string", "format": "uuid" }, "waiting": { "type": "boolean" }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NotificationChannelKind": { "enum": [ 1, 2, 3 ], "type": "integer", "format": "int32" }, "NotificationDeliveryMode": { "enum": [ 1, 2 ], "type": "integer", "format": "int32" }, "NotificationDeliveryResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "eventType": { "$ref": "#/components/schemas/NotificationEventType" }, "destinationKind": { "$ref": "#/components/schemas/NotificationChannelKind" }, "destinationName": { "type": "string", "nullable": true }, "endpointFingerprint": { "type": "string", "nullable": true }, "recipientUserId": { "type": "string", "format": "uuid", "nullable": true }, "recipientAddress": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/NotificationDeliveryStatus" }, "attempts": { "type": "integer", "format": "int32" }, "sentAt": { "type": "string", "format": "date-time", "nullable": true }, "error": { "type": "string", "nullable": true }, "providerMessageId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "subjects": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationDeliverySubjectResponse" }, "nullable": true } }, "additionalProperties": false }, "NotificationDeliveryStatus": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32" }, "NotificationDeliverySubjectResponse": { "type": "object", "properties": { "pageId": { "type": "string", "format": "uuid", "nullable": true }, "metaAppId": { "type": "string", "format": "uuid", "nullable": true }, "pageIssueId": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NotificationDestinationResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "kind": { "$ref": "#/components/schemas/NotificationChannelKind" }, "name": { "type": "string", "nullable": true }, "hasEndpoint": { "type": "boolean" }, "isActive": { "type": "boolean" }, "verifiedAt": { "type": "string", "format": "date-time", "nullable": true }, "lastError": { "type": "string", "nullable": true }, "supportsRecipients": { "type": "boolean" }, "recipients": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationRecipientResponse" }, "nullable": true } }, "additionalProperties": false }, "NotificationEndpointTestRequest": { "type": "object", "properties": { "kind": { "$ref": "#/components/schemas/NotificationChannelKind" }, "endpoint": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NotificationEventType": { "enum": [ 1, 2, 3, 4, 5, 6, 10, 11, 12, 13 ], "type": "integer", "format": "int32" }, "NotificationEventTypeResponse": { "type": "object", "properties": { "eventType": { "$ref": "#/components/schemas/NotificationEventType" }, "isProducible": { "type": "boolean" } }, "additionalProperties": false }, "NotificationListMembershipResponse": { "type": "object", "properties": { "destinationId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "isLastRecipient": { "type": "boolean" } }, "additionalProperties": false }, "NotificationRecipientResponse": { "type": "object", "properties": { "userId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "deliveryMode": { "$ref": "#/components/schemas/NotificationDeliveryMode" }, "isSelf": { "type": "boolean" } }, "additionalProperties": false }, "NotificationRecipientsRequest": { "type": "object", "properties": { "userIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "NotificationScopeMode": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "NotificationSubscriptionRequest": { "type": "object", "properties": { "destinationId": { "type": "string", "format": "uuid" }, "eventType": { "$ref": "#/components/schemas/NotificationEventType" }, "minSeverity": { "$ref": "#/components/schemas/PageIssueSeverity" }, "deliveryMode": { "$ref": "#/components/schemas/NotificationDeliveryMode" }, "scopeMode": { "$ref": "#/components/schemas/NotificationScopeMode" }, "isActive": { "type": "boolean" }, "pageIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "categoryIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "NotificationSubscriptionResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "destinationId": { "type": "string", "format": "uuid" }, "destinationName": { "type": "string", "nullable": true }, "destinationKind": { "$ref": "#/components/schemas/NotificationChannelKind" }, "eventType": { "$ref": "#/components/schemas/NotificationEventType" }, "minSeverity": { "$ref": "#/components/schemas/PageIssueSeverity" }, "deliveryMode": { "$ref": "#/components/schemas/NotificationDeliveryMode" }, "scopeMode": { "$ref": "#/components/schemas/NotificationScopeMode" }, "isActive": { "type": "boolean" }, "pageIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "categoryIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "NotificationTestRequest": { "type": "object", "properties": { "userId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "NotificationTestResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NotificationType": { "enum": [ 1, 2, 3 ], "type": "integer", "format": "int32" }, "OutcomeFreshness": { "type": "object", "properties": { "source": { "$ref": "#/components/schemas/MessageOutcomeSource" }, "pendingUntil": { "type": "string", "format": "date-time", "nullable": true }, "coveredFrom": { "type": "string", "format": "date-time", "nullable": true }, "isSettled": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PageAlertResponse": { "type": "object", "properties": { "pageId": { "type": "string", "format": "uuid" }, "pageName": { "type": "string", "nullable": true }, "pageReferenceId": { "type": "string", "nullable": true }, "providerId": { "type": "integer", "format": "int32", "nullable": true }, "categoryId": { "type": "string", "format": "uuid", "nullable": true }, "categoryName": { "type": "string", "nullable": true }, "connectedByNames": { "type": "array", "items": { "type": "string" }, "nullable": true }, "lastOccurrenceAt": { "type": "string", "format": "date-time" }, "accountId": { "type": "string", "format": "uuid", "nullable": true }, "accountName": { "type": "string", "nullable": true }, "issues": { "type": "array", "items": { "$ref": "#/components/schemas/AlertIssueResponse" }, "nullable": true } }, "additionalProperties": false }, "PageBatchError": { "type": "object", "properties": { "pageId": { "type": "string", "format": "uuid" }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PageBatchResult": { "type": "object", "properties": { "successCount": { "type": "integer", "format": "int32" }, "failureCount": { "type": "integer", "format": "int32" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/PageBatchError" }, "nullable": true } }, "additionalProperties": false }, "PageFacetsResponse": { "type": "object", "properties": { "providers": { "type": "array", "items": { "$ref": "#/components/schemas/FacetCountModel" }, "nullable": true }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryFacetModel" }, "nullable": true }, "countries": { "type": "array", "items": { "$ref": "#/components/schemas/FacetCountModel" }, "nullable": true }, "statuses": { "type": "array", "items": { "$ref": "#/components/schemas/FacetCountModel" }, "nullable": true }, "integrityStatuses": { "type": "array", "items": { "$ref": "#/components/schemas/FacetCountModel" }, "nullable": true }, "hosts": { "type": "array", "items": { "$ref": "#/components/schemas/FacetCountModel" }, "nullable": true }, "profiles": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionProfileResponse" }, "nullable": true }, "attentionCount": { "type": "integer", "format": "int32" }, "transientErrorCount": { "type": "integer", "format": "int32" }, "missingBroadcasts24h": { "type": "integer", "format": "int32" }, "missingFlows": { "type": "integer", "format": "int32" }, "missingLeads": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PageHealthCountsResponse": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "active": { "type": "integer", "format": "int32" }, "tokenExpired": { "type": "integer", "format": "int32" }, "blocked": { "type": "integer", "format": "int32" }, "needingAttention": { "type": "integer", "format": "int32" }, "healthy": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PageHealthResponse": { "type": "object", "properties": { "webhookSubscribed": { "type": "boolean" }, "messengerProfileConfigured": { "type": "boolean" }, "promoted": { "type": "boolean" }, "skipReason": { "type": "string", "nullable": true }, "probeFailure": { "$ref": "#/components/schemas/ProviderProbeFailure" } }, "additionalProperties": false }, "PageIdsRequest": { "type": "object", "properties": { "pageIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "PageIntegrityDetailsResponse": { "type": "object", "properties": { "status": { "type": "string", "nullable": true }, "statusChangedAt": { "type": "string", "format": "date-time", "nullable": true }, "violations": { "type": "array", "items": { "$ref": "#/components/schemas/PageIntegrityViolationModel" }, "nullable": true }, "restrictions": { "type": "array", "items": { "$ref": "#/components/schemas/PageIntegrityRestrictionModel" }, "nullable": true }, "recommendedActions": { "type": "array", "items": { "$ref": "#/components/schemas/PageIntegrityRecommendedActionModel" }, "nullable": true } }, "additionalProperties": false }, "PageIntegrityRecommendedActionModel": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "violationType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PageIntegrityRestrictionModel": { "type": "object", "properties": { "feature": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "appliedAt": { "type": "string", "format": "date-time", "nullable": true }, "expiresAt": { "type": "string", "format": "date-time", "nullable": true }, "violationType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PageIntegrityViolationModel": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "PageIssueModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "pageId": { "type": "string", "format": "uuid" }, "tokenId": { "type": "string", "format": "uuid", "nullable": true }, "metaAppId": { "type": "string", "format": "uuid", "nullable": true }, "metaAppName": { "type": "string", "nullable": true }, "scope": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/PageIssueType" }, "status": { "$ref": "#/components/schemas/PageIssueStatus" }, "severity": { "$ref": "#/components/schemas/PageIssueSeverity" }, "errorCode": { "type": "integer", "format": "int32", "nullable": true }, "errorSubcode": { "type": "integer", "format": "int32", "nullable": true }, "message": { "type": "string", "nullable": true }, "occurrenceCount": { "type": "integer", "format": "int32" }, "firstOccurrenceAt": { "type": "string", "format": "date-time" }, "lastOccurrenceAt": { "type": "string", "format": "date-time" }, "resolvedAt": { "type": "string", "format": "date-time", "nullable": true }, "resolvedBy": { "type": "string", "format": "uuid", "nullable": true }, "resolutionNote": { "type": "string", "nullable": true }, "connectionEpoch": { "type": "integer", "format": "int32", "nullable": true }, "occurredAt": { "type": "string", "format": "date-time", "nullable": true }, "isStale": { "type": "boolean" }, "isCurrentConnection": { "type": "boolean" } }, "additionalProperties": false }, "PageIssueSeverity": { "enum": [ 1, 2 ], "type": "integer", "format": "int32" }, "PageIssueStatus": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32" }, "PageIssueType": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ], "type": "integer", "format": "int32" }, "PageResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "accountName": { "type": "string", "nullable": true }, "provider": { "$ref": "#/components/schemas/ProviderType" }, "referenceId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/PageStatus" }, "categoryId": { "type": "string", "format": "uuid", "nullable": true }, "categoryName": { "type": "string", "nullable": true }, "categoryVariableGroupId": { "type": "string", "format": "uuid", "nullable": true }, "timeZone": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "currency": { "type": "string", "nullable": true }, "countryCode": { "type": "string", "nullable": true }, "appId": { "type": "string", "nullable": true }, "metaAppId": { "type": "string", "format": "uuid", "nullable": true }, "metaAppName": { "type": "string", "nullable": true }, "lastConnectedAt": { "type": "string", "format": "date-time", "nullable": true }, "connectedByName": { "type": "string", "nullable": true }, "connectedProfiles": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectedProfileModel" }, "nullable": true }, "connectedApps": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectedAppModel" }, "nullable": true }, "openIssueCount": { "type": "integer", "format": "int32" }, "loggedIssueCount24h": { "type": "integer", "format": "int32" }, "issues": { "type": "array", "items": { "$ref": "#/components/schemas/PageIssueModel" }, "nullable": true }, "leadCount": { "type": "integer", "format": "int64" }, "leadsToday": { "type": "integer", "format": "int64" }, "leads7d": { "type": "integer", "format": "int64" }, "profileCounts": { "$ref": "#/components/schemas/ProfileCountsByStatusModel" }, "urls": { "type": "array", "items": { "$ref": "#/components/schemas/PageUrlModel" }, "nullable": true }, "urlCount": { "type": "integer", "format": "int32" }, "integrityStatus": { "type": "string", "nullable": true }, "integrityStatusChangedAt": { "type": "string", "format": "date-time", "nullable": true }, "integrityViolationTypes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "schemas": { "type": "array", "items": { "$ref": "#/components/schemas/PageSchemaModel" }, "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "PageSchemaModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "channelTrigger": { "$ref": "#/components/schemas/ChannelTrigger" }, "isKeywordOnly": { "type": "boolean" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "PageStatus": { "enum": [ 0, 1, 2, 3, -1 ], "type": "integer", "format": "int32" }, "PageUrlHealthResponse": { "type": "object", "properties": { "url": { "type": "string", "nullable": true }, "host": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/UrlHealthStatus" }, "statusChangedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "PageUrlModel": { "type": "object", "properties": { "host": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "source": { "$ref": "#/components/schemas/PageUrlSource" }, "label": { "type": "string", "nullable": true }, "weight": { "type": "integer", "format": "int32", "nullable": true }, "health": { "$ref": "#/components/schemas/UrlHealthStatus" }, "healthChangedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "PageUrlSource": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PageVariableCopyResponse": { "type": "object", "properties": { "copiedCount": { "type": "integer", "format": "int32" }, "skippedCount": { "type": "integer", "format": "int32" }, "totalSource": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PageVariableResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "pageId": { "type": "string", "format": "uuid" }, "key": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "dynamicValue": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/VariableType" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "PendingConnectionsResponse": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ProfileCountsByStatusModel": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64" }, "active": { "type": "integer", "format": "int64" }, "blocked": { "type": "integer", "format": "int64" }, "deleted": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "ProviderProbeFailure": { "type": "object", "properties": { "source": { "type": "string", "nullable": true }, "code": { "type": "integer", "format": "int32", "nullable": true }, "subcode": { "type": "integer", "format": "int32", "nullable": true }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProviderType": { "enum": [ 1, 2, 3 ], "type": "integer", "format": "int32" }, "RecencyBasis": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "RetryQueuedResponse": { "type": "object", "properties": { "queued": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "RetryUtilityTemplateRequest": { "type": "object", "properties": { "pageId": { "type": "string", "format": "uuid" }, "routeName": { "type": "string", "nullable": true }, "interactionIndex": { "type": "integer", "format": "int32" }, "language": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RetryUtilityTemplatesRequest": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UtilityTemplateRetryItem" }, "nullable": true } }, "additionalProperties": false }, "RouteArmDecision": { "type": "object", "properties": { "route": { "type": "string", "nullable": true }, "selections": { "type": "integer", "format": "int64" }, "clicks": { "type": "integer", "format": "int64" }, "clickRate": { "type": "number", "format": "double" }, "probabilityBest": { "type": "number", "format": "double" }, "currentWeight": { "type": "number", "format": "double" }, "suggestedWeight": { "type": "number", "format": "double" } }, "additionalProperties": false }, "RouteWeightSuggestion": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "schemaId": { "type": "string", "format": "uuid" }, "nodeId": { "type": "string", "nullable": true }, "computedAt": { "type": "string", "format": "date-time" }, "windowFrom": { "type": "string", "format": "date-time" }, "windowUntil": { "type": "string", "format": "date-time" }, "objective": { "type": "string", "nullable": true }, "routes": { "type": "array", "items": { "$ref": "#/components/schemas/RouteArmDecision" }, "nullable": true }, "reason": { "type": "string", "nullable": true }, "applied": { "type": "boolean" } }, "additionalProperties": false }, "SaveBroadcastRequest": { "type": "object", "properties": { "schemaId": { "type": "string", "format": "uuid" }, "pageIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "type": { "$ref": "#/components/schemas/BroadcastType" }, "topicName": { "type": "string", "nullable": true }, "messageTag": { "$ref": "#/components/schemas/BroadcastMessageTag" }, "recencyFilter": { "$ref": "#/components/schemas/BroadcastRecencyFilter" }, "recencyBasis": { "$ref": "#/components/schemas/RecencyBasis" }, "recencyOlderThanHours": { "type": "integer", "format": "int32", "nullable": true }, "recencyNewerThanHours": { "type": "integer", "format": "int32", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "tagMatchMode": { "$ref": "#/components/schemas/TagMatchMode" }, "deliveryIntelligence": { "$ref": "#/components/schemas/BroadcastDeliveryIntelligence" }, "notificationType": { "$ref": "#/components/schemas/NotificationType" }, "onlySubscribers": { "type": "boolean" }, "subscriptionTag": { "type": "string", "nullable": true }, "scheduledTo": { "type": "string", "format": "date-time", "nullable": true }, "isImmediate": { "type": "boolean" }, "channelTargets": { "type": "array", "items": { "$ref": "#/components/schemas/BroadcastChannelTargetItem" }, "nullable": true } }, "additionalProperties": false }, "SaveJourneyRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "mode": { "$ref": "#/components/schemas/JourneyMode" }, "repeatFromStart": { "type": "boolean" }, "cycleGapHours": { "type": "integer", "format": "int32", "nullable": true }, "entryDelayHours": { "type": "integer", "format": "int32", "nullable": true }, "provider": { "$ref": "#/components/schemas/ProviderType" }, "pageIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "categoryIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "dynamicUpdate": { "type": "boolean", "nullable": true }, "steps": { "type": "array", "items": { "$ref": "#/components/schemas/JourneyStepDefinition" }, "nullable": true }, "deliveryIntelligence": { "$ref": "#/components/schemas/DeliveryRuleSettings" }, "anchorDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "SaveSchemaRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "provider": { "$ref": "#/components/schemas/ProviderType" }, "status": { "$ref": "#/components/schemas/SchemaStatusType" }, "script": { "type": "string", "nullable": true }, "pageIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "messageTriggers": { "type": "array", "items": { "type": "string" }, "nullable": true }, "triggerLabels": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "triggerMatchType": { "$ref": "#/components/schemas/TriggerMatchType" }, "unsubscribeMessageTriggers": { "type": "array", "items": { "type": "string" }, "nullable": true }, "unsubscribeTriggerMatchType": { "$ref": "#/components/schemas/TriggerMatchType" }, "channelTrigger": { "$ref": "#/components/schemas/ChannelTrigger" }, "trackLinkClicks": { "type": "boolean", "nullable": true }, "conversationSettings": { "$ref": "#/components/schemas/ConversationSettings" }, "dynamicUpdate": { "$ref": "#/components/schemas/SchemaDynamicUpdate" }, "channelTargets": { "type": "array", "items": { "$ref": "#/components/schemas/SchemaChannelTarget" }, "nullable": true }, "translation": { "$ref": "#/components/schemas/SchemaTranslationResponse" } }, "additionalProperties": false }, "SchemaBroadcastMetricsSummary": { "type": "object", "properties": { "broadcastId": { "type": "string", "format": "uuid" }, "date": { "type": "string", "format": "date-time" }, "status": { "type": "string", "nullable": true }, "sent": { "type": "integer", "format": "int64" }, "delivered": { "type": "integer", "format": "int64" }, "reads": { "type": "integer", "format": "int64" }, "readRate": { "type": "number", "format": "double" }, "clicks": { "type": "integer", "format": "int64" }, "outcomes": { "$ref": "#/components/schemas/OutcomeFreshness" } }, "additionalProperties": false }, "SchemaButtonMetricsReport": { "type": "object", "properties": { "buttonId": { "type": "string", "nullable": true }, "clicks": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "SchemaCategory": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SchemaCategoryCountResponse": { "type": "object", "properties": { "categoryId": { "type": "string", "format": "uuid", "nullable": true }, "categoryName": { "type": "string", "nullable": true }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "SchemaCategoryReference": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SchemaChannelTarget": { "type": "object", "properties": { "pageId": { "type": "string", "format": "uuid" }, "includeProfiles": { "type": "boolean" }, "channelReferenceIds": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "SchemaDynamicUpdate": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "additionalProperties": false }, "SchemaLanguageTranslation": { "type": "object", "properties": { "language": { "type": "string", "nullable": true }, "script": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/TranslationStatusType" }, "scriptHash": { "type": "string", "nullable": true }, "lastAttemptAt": { "type": "string", "format": "date-time", "nullable": true }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "errorMessage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SchemaMetricsReport": { "type": "object", "properties": { "schemaId": { "type": "string", "format": "uuid" }, "broadcastId": { "type": "string", "format": "uuid", "nullable": true }, "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/SchemaNodeMetricsReport" }, "nullable": true }, "outcomes": { "$ref": "#/components/schemas/OutcomeFreshness" } }, "additionalProperties": false }, "SchemaNodeMetricsReport": { "type": "object", "properties": { "nodeId": { "type": "string", "nullable": true }, "sent": { "type": "integer", "format": "int64" }, "delivered": { "type": "integer", "format": "int64" }, "reads": { "type": "integer", "format": "int64" }, "readRate": { "type": "number", "format": "double" }, "clicks": { "type": "integer", "format": "int64" }, "buttons": { "type": "array", "items": { "$ref": "#/components/schemas/SchemaButtonMetricsReport" }, "nullable": true } }, "additionalProperties": false }, "SchemaPageReference": { "type": "object", "properties": { "referenceId": { "type": "string", "nullable": true }, "providerId": { "$ref": "#/components/schemas/ProviderType" }, "categoryId": { "type": "string", "format": "uuid", "nullable": true }, "status": { "$ref": "#/components/schemas/PageStatus" }, "language": { "type": "string", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SchemaResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "provider": { "$ref": "#/components/schemas/ProviderType" }, "status": { "$ref": "#/components/schemas/SchemaStatusType" }, "script": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "messageTriggers": { "type": "array", "items": { "type": "string" }, "nullable": true }, "triggerLabels": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "triggerMatchType": { "$ref": "#/components/schemas/TriggerMatchType" }, "unsubscribeMessageTriggers": { "type": "array", "items": { "type": "string" }, "nullable": true }, "unsubscribeTriggerMatchType": { "$ref": "#/components/schemas/TriggerMatchType" }, "channelTrigger": { "$ref": "#/components/schemas/ChannelTrigger" }, "trackLinkClicks": { "type": "boolean", "nullable": true }, "conversationSettings": { "$ref": "#/components/schemas/ConversationSettings" }, "dynamicUpdate": { "$ref": "#/components/schemas/SchemaDynamicUpdate" }, "channelTargets": { "type": "array", "items": { "$ref": "#/components/schemas/SchemaChannelTarget" }, "nullable": true }, "translation": { "$ref": "#/components/schemas/SchemaTranslationResponse" }, "variableValidation": { "$ref": "#/components/schemas/SchemaVariableValidationResponse" }, "pages": { "type": "array", "items": { "$ref": "#/components/schemas/SchemaPageReference" }, "nullable": true }, "totalPages": { "type": "integer", "format": "int32" }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/SchemaCategoryReference" }, "nullable": true }, "createdByUser": { "$ref": "#/components/schemas/AuditedBy" }, "updatedByUser": { "$ref": "#/components/schemas/AuditedBy" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "SchemaStatusType": { "enum": [ 0, 1, -2, -1 ], "type": "integer", "format": "int32" }, "SchemaTranslationResponse": { "type": "object", "properties": { "enable": { "type": "boolean", "nullable": true }, "status": { "$ref": "#/components/schemas/TranslationStatusType" }, "languages": { "type": "array", "items": { "$ref": "#/components/schemas/SchemaLanguageTranslation" }, "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "SchemaVariableProblem": { "type": "object", "properties": { "referenceId": { "type": "string", "nullable": true }, "providerId": { "$ref": "#/components/schemas/ProviderType" }, "categoryId": { "type": "string", "format": "uuid", "nullable": true }, "status": { "$ref": "#/components/schemas/PageStatus" }, "language": { "type": "string", "nullable": true }, "pageId": { "type": "string", "format": "uuid" }, "pageName": { "type": "string", "nullable": true }, "missingVariables": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "SchemaVariableValidationResponse": { "type": "object", "properties": { "status": { "type": "string", "nullable": true }, "totalPages": { "type": "integer", "format": "int32" }, "pagesWithProblems": { "type": "integer", "format": "int32" }, "problems": { "type": "array", "items": { "$ref": "#/components/schemas/SchemaVariableProblem" }, "nullable": true }, "validatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "SendTimeBasis": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "SendTimeHourResponse": { "type": "object", "properties": { "hour": { "type": "integer", "format": "int32" }, "delivered": { "type": "integer", "format": "int64" }, "observedRead6hRate": { "type": "number", "format": "double", "nullable": true }, "observedRead1hRate": { "type": "number", "format": "double", "nullable": true }, "priorIndex": { "type": "number", "format": "double", "nullable": true }, "estimatedRate": { "type": "number", "format": "double", "nullable": true }, "low": { "type": "number", "format": "double", "nullable": true }, "high": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "SendTimeSuggestionResponse": { "type": "object", "properties": { "pageId": { "type": "string", "format": "uuid" }, "windowFrom": { "type": "string", "format": "date-time" }, "windowUntil": { "type": "string", "format": "date-time" }, "basis": { "$ref": "#/components/schemas/SendTimeBasis" }, "observedHours": { "type": "integer", "format": "int32" }, "pageAverageRate": { "type": "number", "format": "double", "nullable": true }, "suggestedHours": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "expectedLift": { "type": "number", "format": "double", "nullable": true }, "conservativeLift": { "type": "number", "format": "double", "nullable": true }, "hours": { "type": "array", "items": { "$ref": "#/components/schemas/SendTimeHourResponse" }, "nullable": true } }, "additionalProperties": false }, "TagEventAction": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "TagMatchMode": { "enum": [ 1, 2 ], "type": "integer", "format": "int32" }, "TagResponse": { "type": "object", "properties": { "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TelegramBotPresentation": { "type": "object", "properties": { "description": { "type": "string", "nullable": true }, "shortDescription": { "type": "string", "nullable": true }, "commands": { "type": "array", "items": { "$ref": "#/components/schemas/TelegramCommandItem" }, "nullable": true }, "languageCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TelegramChannelResponse": { "type": "object", "properties": { "channelReferenceId": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "canPostMessages": { "type": "boolean" }, "isActive": { "type": "boolean" } }, "additionalProperties": false }, "TelegramCommandItem": { "type": "object", "properties": { "command": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TelegramPageResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/PageStatus" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "TemplateComponent": { "type": "object", "additionalProperties": false }, "TemplateComponentVariable": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "variables": { "type": "array", "items": { "type": "string" }, "nullable": true }, "parameterNames": { "type": "array", "items": { "type": "string" }, "nullable": true }, "urlPattern": { "type": "string", "nullable": true }, "lockedBaseUrl": { "type": "string", "nullable": true }, "payload": { "type": "string", "nullable": true }, "fallbackUrlPattern": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TemplateInfo": { "type": "object", "properties": { "pageId": { "type": "string", "format": "uuid" }, "pageReferenceId": { "type": "string", "nullable": true }, "routeName": { "type": "string", "nullable": true }, "interactionIndex": { "type": "integer", "format": "int32" }, "templateId": { "type": "string", "nullable": true }, "templateName": { "type": "string", "nullable": true }, "languageCode": { "type": "string", "nullable": true }, "domainSignature": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "errorMessage": { "type": "string", "nullable": true }, "componentVariables": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateComponentVariable" }, "nullable": true }, "components": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateSendComponent" }, "nullable": true }, "requiresReapproval": { "type": "boolean" }, "accountId": { "type": "string", "format": "uuid" }, "flowName": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "interactionJson": { "type": "string", "nullable": true }, "visibility": { "$ref": "#/components/schemas/TemplateVisibility" }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/SchemaCategory" }, "nullable": true }, "createdByUser": { "$ref": "#/components/schemas/UserAudit" } }, "additionalProperties": false }, "TemplateLibraryItem": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "category": { "type": "string", "nullable": true }, "topic": { "type": "string", "nullable": true }, "usecase": { "type": "string", "nullable": true }, "industry": { "type": "array", "items": { "type": "string" }, "nullable": true }, "header": { "type": "string", "nullable": true }, "body": { "type": "string", "nullable": true }, "body_params": { "type": "array", "items": { "type": "string" }, "nullable": true }, "buttons": { "type": "array", "items": { "$ref": "#/components/schemas/Button" }, "nullable": true } }, "additionalProperties": false }, "TemplateSendComponent": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateSendParameter" }, "nullable": true } }, "additionalProperties": false }, "TemplateSendParameter": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "parameterName": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "payload": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TemplateVisibility": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "TestSchemaRequest": { "type": "object", "properties": { "pageId": { "type": "string", "format": "uuid" }, "leadId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "TimezoneResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "utcOffset": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TokenChannel": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32" }, "TokenStatus": { "enum": [ 0, 1, -3, -2, -1 ], "type": "integer", "format": "int32" }, "TranslationStatusType": { "enum": [ 0, 1, 2, 3, 4, -1 ], "type": "integer", "format": "int32" }, "TriggerMatchType": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "UnmatchedSettings": { "type": "object", "properties": { "mode": { "type": "string", "nullable": true }, "route": { "type": "string", "nullable": true }, "schemaId": { "type": "string", "format": "uuid", "nullable": true }, "onEnd": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateAccountRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "pictureUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateBroadcastRequest": { "type": "object", "properties": { "schemaId": { "type": "string", "format": "uuid", "nullable": true }, "pageIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "type": { "$ref": "#/components/schemas/BroadcastType" }, "topicName": { "type": "string", "nullable": true }, "messageTag": { "$ref": "#/components/schemas/BroadcastMessageTag" }, "recencyFilter": { "$ref": "#/components/schemas/BroadcastRecencyFilter" }, "recencyBasis": { "$ref": "#/components/schemas/RecencyBasis" }, "recencyOlderThanHours": { "type": "integer", "format": "int32", "nullable": true }, "recencyNewerThanHours": { "type": "integer", "format": "int32", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "tagMatchMode": { "$ref": "#/components/schemas/TagMatchMode" }, "deliveryIntelligence": { "$ref": "#/components/schemas/BroadcastDeliveryIntelligence" }, "notificationType": { "$ref": "#/components/schemas/NotificationType" }, "onlySubscribers": { "type": "boolean", "nullable": true }, "subscriptionTag": { "type": "string", "nullable": true }, "scheduledTo": { "type": "string", "format": "date-time", "nullable": true }, "isImmediate": { "type": "boolean", "nullable": true }, "channelTargets": { "type": "array", "items": { "$ref": "#/components/schemas/BroadcastChannelTargetItem" }, "nullable": true } }, "additionalProperties": false }, "UpdateCategoryRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateMetaAppRequest": { "type": "object", "properties": { "appId": { "type": "string", "nullable": true }, "secret": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/MetaAppStatus" }, "isDefault": { "type": "boolean", "nullable": true }, "extraScopes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "scope": { "$ref": "#/components/schemas/MetaAppScope" }, "companyId": { "type": "string", "format": "uuid", "nullable": true }, "accountIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "UpdateMetaDatasetRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "metaDatasetId": { "type": "string", "nullable": true }, "accessToken": { "type": "string", "nullable": true }, "testEventCode": { "type": "string", "nullable": true }, "websiteEventName": { "type": "string", "nullable": true }, "messagingEventName": { "type": "string", "nullable": true }, "isActive": { "type": "boolean", "nullable": true }, "appliesToAllPages": { "type": "boolean", "nullable": true }, "categoryIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "changesFields": { "type": "boolean", "readOnly": true }, "changesCoverage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "UpdateNotificationDestinationRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "maxLength": 120, "minLength": 1, "type": "string" }, "kind": { "$ref": "#/components/schemas/NotificationChannelKind" }, "endpoint": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" } }, "additionalProperties": false }, "UpdatePageRequest": { "type": "object", "properties": { "timeZone": { "maxLength": 100, "type": "string", "nullable": true }, "language": { "maxLength": 10, "type": "string", "nullable": true }, "currency": { "maxLength": 3, "type": "string", "nullable": true }, "countryCode": { "maxLength": 2, "minLength": 2, "type": "string", "nullable": true }, "categoryId": { "type": "string", "format": "uuid", "nullable": true }, "categoryVariableGroupId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "UpdatePagesRequest": { "type": "object", "properties": { "pageIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "settings": { "$ref": "#/components/schemas/UpdatePageRequest" } }, "additionalProperties": false }, "UpdateSchemaRequest": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/SchemaStatusType" } }, "additionalProperties": false }, "UpdateVariableGroupRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "isDefault": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "UpdateVariableRequest": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "dynamicValue": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/VariableType" } }, "additionalProperties": false }, "UploadResponse": { "type": "object", "properties": { "url": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UrlHealthStatus": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32" }, "UrlPatternType": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32" }, "UserAudit": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "date": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "UserNotificationListsResponse": { "type": "object", "properties": { "userId": { "type": "string", "format": "uuid" }, "lists": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationListMembershipResponse" }, "nullable": true } }, "additionalProperties": false }, "UtilityTemplateRetryItem": { "type": "object", "properties": { "templateId": { "type": "string", "nullable": true }, "pageId": { "type": "string", "format": "uuid" }, "routeName": { "type": "string", "nullable": true }, "interactionIndex": { "type": "integer", "format": "int32" }, "language": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ValidateSchemaVariablesRequest": { "type": "object", "properties": { "script": { "type": "string", "nullable": true }, "pageIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "ValidateWebsiteScriptRequest": { "type": "object", "properties": { "script": { "type": "string", "nullable": true }, "categoryIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "VariableBatchResponse": { "type": "object", "properties": { "affected": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "VariableGroupDetailResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "categoryId": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "isDefault": { "type": "boolean" }, "variables": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryVariableResponse" }, "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "VariableGroupResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "categoryId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "isDefault": { "type": "boolean" }, "variableCount": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "VariableRequest": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "dynamicValue": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/VariableType" } }, "additionalProperties": false }, "VariableType": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "VoiceMessageResponse": { "type": "object", "properties": { "url": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WebsiteCategoryWeight": { "type": "object", "properties": { "categoryId": { "type": "string", "format": "uuid" }, "weight": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "WebsiteDomainRequest": { "type": "object", "properties": { "host": { "type": "string", "nullable": true }, "urlPattern": { "$ref": "#/components/schemas/UrlPatternType" }, "langSegmentIndex": { "type": "integer", "format": "int32" }, "langQueryParam": { "type": "string", "nullable": true }, "weight": { "type": "integer", "format": "int32" }, "defaultLanguage": { "type": "string", "nullable": true }, "metricsEnabled": { "type": "boolean" }, "utmSourceValue": { "type": "string", "nullable": true }, "utmMediumValue": { "type": "string", "nullable": true }, "utmCampaignValue": { "type": "string", "nullable": true }, "utmTermValue": { "type": "string", "nullable": true }, "utmContentValue": { "type": "string", "nullable": true }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/WebsiteCategoryWeight" }, "nullable": true }, "languages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "WebsiteDomainResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "host": { "type": "string", "nullable": true }, "urlPattern": { "$ref": "#/components/schemas/UrlPatternType" }, "langSegmentIndex": { "type": "integer", "format": "int32" }, "langQueryParam": { "type": "string", "nullable": true }, "weight": { "type": "integer", "format": "int32" }, "defaultLanguage": { "type": "string", "nullable": true }, "metricsEnabled": { "type": "boolean" }, "utmSourceValue": { "type": "string", "nullable": true }, "utmMediumValue": { "type": "string", "nullable": true }, "utmCampaignValue": { "type": "string", "nullable": true }, "utmTermValue": { "type": "string", "nullable": true }, "utmContentValue": { "type": "string", "nullable": true }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/WebsiteCategoryWeight" }, "nullable": true }, "languages": { "type": "array", "items": { "type": "string" }, "nullable": true }, "websites": { "type": "array", "items": { "$ref": "#/components/schemas/WebsiteResponse" }, "nullable": true }, "createdBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "WebsiteDomainSlugRequest": { "type": "object", "properties": { "languageTag": { "type": "string", "nullable": true }, "slug": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WebsiteDomainSlugResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "languageTag": { "type": "string", "nullable": true }, "slug": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WebsiteRequest": { "type": "object", "properties": { "path": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "weight": { "type": "integer", "format": "int32" }, "metricsEnabled": { "type": "boolean", "nullable": true }, "utmCampaignValue": { "type": "string", "nullable": true }, "utmTermValue": { "type": "string", "nullable": true }, "utmContentValue": { "type": "string", "nullable": true }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/WebsiteCategoryWeight" }, "nullable": true } }, "additionalProperties": false }, "WebsiteResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "domainId": { "type": "string", "format": "uuid" }, "path": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "weight": { "type": "integer", "format": "int32" }, "metricsEnabled": { "type": "boolean", "nullable": true }, "utmCampaignValue": { "type": "string", "nullable": true }, "utmTermValue": { "type": "string", "nullable": true }, "utmContentValue": { "type": "string", "nullable": true }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/WebsiteCategoryWeight" }, "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "WebsiteScriptValidationResponse": { "type": "object", "properties": { "emptyCategories": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "http", "description": "User session JWT or API token (cf_live_..., scoped by area) in the Bearer scheme. Example: \"Authorization: Bearer {token}\"", "scheme": "Bearer", "bearerFormat": "JWT" }, "ApiKey": { "type": "apiKey", "description": "API token (cf_live_...) in the X-Api-Key header, as an alternative to the Bearer scheme.", "name": "X-Api-Key", "in": "header" } } }, "security": [ { "Bearer": [ ] }, { "ApiKey": [ ] } ], "tags": [ { "name": "AccountBilling" }, { "name": "AccountLanguageSlugs" }, { "name": "AccountNotificationUsers" }, { "name": "Accounts" }, { "name": "AccountUtm" }, { "name": "Broadcasts" }, { "name": "Categories" }, { "name": "Connections" }, { "name": "DeliveryPreviews" }, { "name": "DynamicVariables" }, { "name": "Journeys" }, { "name": "Leads" }, { "name": "Me" }, { "name": "Media" }, { "name": "MetaApps" }, { "name": "MetaDatasets" }, { "name": "MetaPages" }, { "name": "MetaTemplates" }, { "name": "Notifications" }, { "name": "PageAlerts" }, { "name": "PageMetaApps" }, { "name": "Pages" }, { "name": "PageVariables" }, { "name": "Reference" }, { "name": "Schemas" }, { "name": "Tags" }, { "name": "TelegramPages" }, { "name": "UtilityTemplates" }, { "name": "VariableGroups" }, { "name": "WebsiteDomains" }, { "name": "Websites" } ] }