{ "openapi": "3.1.0", "info": { "title": "Startwave customer API", "version": "controlled-beta", "description": "Only workspace API-key grants. Some responses are untyped in the backend schema; consult the guide and authoritative operation receipts." }, "servers": [ { "url": "https://app.startwave.io" } ], "paths": { "/analytics/verification": { "get": { "summary": "Verification Analytics", "operationId": "verification_analytics_analytics_verification_get", "parameters": [ { "name": "start", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Start" } }, { "name": "end", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "End" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "usage:read" ] } }, "/campaigns": { "get": { "summary": "Campaigns", "operationId": "campaigns_campaigns_get", "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 2048, "default": "", "title": "Cursor" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "archive", "in": "query", "required": false, "schema": { "enum": [ "current", "archived", "all" ], "type": "string", "default": "current", "title": "Archive" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read" ] }, "post": { "summary": "Create", "operationId": "create_campaigns_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:write" ] } }, "/campaigns/{cid}": { "get": { "summary": "Campaign", "operationId": "campaign_campaigns__cid__get", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "default": "", "title": "Cursor" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 100, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read" ] }, "patch": { "summary": "Edit Draft", "operationId": "edit_draft_campaigns__cid__patch", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DraftEdit" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:write" ] } }, "/campaigns/{cid}/audience": { "get": { "summary": "Audience", "operationId": "audience_campaigns__cid__audience_get", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "default": "", "title": "Cursor" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "refill", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ], "title": "Refill" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read" ] } }, "/campaigns/{cid}/contacts": { "post": { "summary": "Append Contacts", "operationId": "append_contacts_campaigns__cid__contacts_post", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactsIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "audiences:write" ] } }, "/campaigns/{cid}/materialization": { "get": { "summary": "Status", "operationId": "status_campaigns__cid__materialization_get", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read" ] } }, "/campaigns/{cid}/refills": { "get": { "summary": "History", "operationId": "history_campaigns__cid__refills_get", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } }, { "name": "before", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Before" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read" ] }, "post": { "summary": "Append", "operationId": "append_campaigns__cid__refills_post", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefillIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "audiences:write" ] } }, "/campaigns/{cid}/refills/{identity}": { "get": { "summary": "Detail", "operationId": "detail_campaigns__cid__refills__identity__get", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } }, { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 0, "default": 0, "title": "After" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read" ] } }, "/campaigns/{cid}/start": { "get": { "summary": "Current Start", "operationId": "current_start_campaigns__cid__start_get", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read" ] }, "post": { "summary": "Start Campaign", "operationId": "start_campaign_campaigns__cid__start_post", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:write", "spending:write" ] } }, "/campaigns/{cid}/start-review": { "post": { "summary": "Start Review", "operationId": "start_review_campaigns__cid__start_review_post", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartReviewIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:write" ] } }, "/campaigns/{cid}/start-reviews": { "get": { "summary": "Start Reviews", "operationId": "start_reviews_campaigns__cid__start_reviews_get", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 128, "default": "", "title": "Cursor" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 100, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read" ] } }, "/campaigns/{cid}/state": { "post": { "summary": "State", "operationId": "state_campaigns__cid__state_post", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignState" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:write" ] } }, "/campaigns/{cid}/verification": { "get": { "summary": "Verification Status", "operationId": "verification_status_campaigns__cid__verification_get", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "default": "", "title": "Cursor" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 100, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read" ] } }, "/campaigns/{cid}/verification/batches": { "get": { "summary": "Current", "operationId": "current_campaigns__cid__verification_batches_get", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read" ] }, "post": { "summary": "Start", "operationId": "start_campaigns__cid__verification_batches_post", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Review" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "audiences:write", "spending:write" ] } }, "/campaigns/{cid}/windows": { "get": { "summary": "Campaign Windows", "operationId": "campaign_windows_campaigns__cid__windows_get", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 2048, "default": "", "title": "Cursor" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 31, "minimum": 1, "default": 7, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read" ] } }, "/capacity/current": { "get": { "summary": "Current Capacity", "operationId": "current_capacity_capacity_current_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "usage:read" ] } }, "/capacity/expansions/{identity}": { "get": { "summary": "Status", "operationId": "status_capacity_expansions__identity__get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "usage:read" ] } }, "/capacity/expansions/{identity}/cancel": { "post": { "summary": "Cancel", "operationId": "cancel_capacity_expansions__identity__cancel_post", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:write" ] } }, "/capacity/expansions/{identity}/confirm": { "post": { "summary": "Confirm", "operationId": "confirm_capacity_expansions__identity__confirm_post", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:write", "spending:write" ] } }, "/capacity/operations": { "get": { "summary": "Capacity Operations", "operationId": "capacity_operations_capacity_operations_get", "parameters": [ { "name": "before", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 1024, "default": "", "title": "Before" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "usage:read" ] } }, "/capacity/operations/{activation}/expansions": { "get": { "summary": "History", "operationId": "history_capacity_operations__activation__expansions_get", "parameters": [ { "name": "activation", "in": "path", "required": true, "schema": { "type": "string", "title": "Activation" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 128, "default": "", "title": "Cursor" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 100, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "usage:read" ] }, "post": { "summary": "Quote", "operationId": "quote_capacity_operations__activation__expansions_post", "parameters": [ { "name": "activation", "in": "path", "required": true, "schema": { "type": "string", "title": "Activation" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpansionQuote" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:write" ] } }, "/capacity/operations/{operation}": { "get": { "summary": "Capacity Operation", "operationId": "capacity_operation_capacity_operations__operation__get", "parameters": [ { "name": "operation", "in": "path", "required": true, "schema": { "type": "string", "title": "Operation" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "usage:read" ] } }, "/capacity/quotes": { "post": { "summary": "Quote Capacity", "operationId": "quote_capacity_capacity_quotes_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivationIn" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:write" ] } }, "/compliance": { "get": { "summary": "Read", "operationId": "read_compliance_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read" ] } }, "/conversations": { "get": { "summary": "Conversations", "operationId": "conversations_conversations_get", "parameters": [ { "name": "before", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 2048, "default": "", "title": "Before" } }, { "name": "status", "in": "query", "required": false, "schema": { "enum": [ "all", "needs_reply", "waiting", "closed", "sent" ], "type": "string", "default": "all", "title": "Status" } }, { "name": "archive", "in": "query", "required": false, "schema": { "enum": [ "current", "archived", "all" ], "type": "string", "default": "current", "title": "Archive" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "mine", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Mine" } }, { "name": "unassigned", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Unassigned" } }, { "name": "assignee", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ], "title": "Assignee" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "inbox:read" ] } }, "/conversations/{identity}": { "get": { "summary": "Detail", "operationId": "detail_conversations__identity__get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } }, { "name": "before", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Before" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "inbox:read" ] } }, "/conversations/{identity}/archive": { "patch": { "summary": "Conversation", "operationId": "conversation_conversations__identity__archive_patch", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArchiveIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "inbox:write" ] } }, "/conversations/{identity}/archive-history": { "get": { "summary": "Conversation History", "operationId": "conversation_history_conversations__identity__archive_history_get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } }, { "name": "before", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Before" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "inbox:read" ] } }, "/conversations/{identity}/assignment": { "patch": { "summary": "Assign", "operationId": "assign_conversations__identity__assignment_patch", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignmentIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "inbox:write" ] } }, "/conversations/{identity}/assignments": { "get": { "summary": "History", "operationId": "history_conversations__identity__assignments_get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } }, { "name": "before", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Before" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "inbox:read" ] } }, "/conversations/{identity}/changes": { "get": { "summary": "Changes", "operationId": "changes_conversations__identity__changes_get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } }, { "name": "before", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Before" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "inbox:read" ] } }, "/conversations/{identity}/notes": { "get": { "summary": "Notes", "operationId": "notes_conversations__identity__notes_get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } }, { "name": "before", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Before" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "inbox:read" ] }, "post": { "summary": "Add Note", "operationId": "add_note_conversations__identity__notes_post", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoteIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "inbox:write" ] } }, "/conversations/{identity}/read": { "post": { "summary": "Read", "operationId": "read_conversations__identity__read_post", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReadIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "inbox:write" ] } }, "/conversations/{identity}/status": { "patch": { "summary": "Status", "operationId": "status_conversations__identity__status_patch", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "inbox:write" ] } }, "/inbox": { "get": { "summary": "Inbox", "operationId": "inbox_inbox_get", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "default": "", "title": "Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "inbox:read" ] } }, "/inbox/{event_id}/intent": { "patch": { "summary": "Reply Intent", "operationId": "reply_intent_inbox__event_id__intent_patch", "parameters": [ { "name": "event_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Event Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplyIntentIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "inbox:write" ] } }, "/jobs/{jid}/retries": { "get": { "summary": "History", "operationId": "history_jobs__jid__retries_get", "parameters": [ { "name": "jid", "in": "path", "required": true, "schema": { "type": "string", "title": "Jid" } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "default": "", "title": "After" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "inbox:read" ] } }, "/ledger": { "get": { "summary": "Ledger", "operationId": "ledger_ledger_get", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "default": "", "title": "Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "usage:read" ] } }, "/members": { "get": { "summary": "Members", "operationId": "members_members_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 128, "default": "", "title": "After" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "inbox:read" ] } }, "/replies": { "post": { "summary": "Reply", "operationId": "reply_replies_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplyIn" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "inbox:write", "spending:write" ] } }, "/starts/{identity}": { "get": { "summary": "Start Status", "operationId": "start_status_starts__identity__get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read" ] } }, "/starts/{identity}/cancel": { "post": { "summary": "Cancel Start", "operationId": "cancel_start_starts__identity__cancel_post", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:write" ] } }, "/starts/{identity}/release-capacity": { "post": { "summary": "Release Failed Start", "operationId": "release_failed_start_starts__identity__release_capacity_post", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:write" ] } }, "/starts/{identity}/reuse": { "post": { "summary": "Reuse Start", "operationId": "reuse_start_starts__identity__reuse_post", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReuseIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:write", "spending:write" ] } }, "/suppressions": { "get": { "summary": "Collection", "operationId": "collection_suppressions_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 320, "default": "", "title": "After" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "scope", "in": "query", "required": false, "schema": { "enum": [ "email", "domain" ], "type": "string", "default": "email", "title": "Scope" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "suppressions:read" ] }, "post": { "summary": "Exclude", "operationId": "exclude_suppressions_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExclusionIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "suppressions:write" ] } }, "/suppressions/batch": { "post": { "summary": "Batch", "operationId": "batch_suppressions_batch_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExclusionBatchIn" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "suppressions:write" ] } }, "/suppressions/export": { "get": { "summary": "Export", "operationId": "export_suppressions_export_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 320, "default": "", "title": "After" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 200, "title": "Limit" } }, { "name": "scope", "in": "query", "required": false, "schema": { "enum": [ "email", "domain" ], "type": "string", "default": "email", "title": "Scope" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "suppressions:read" ] } }, "/suppressions/operations": { "get": { "summary": "Operations", "operationId": "operations_suppressions_operations_get", "parameters": [ { "name": "before", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Before" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "suppressions:read" ] } }, "/suppressions/operations/{identity}": { "get": { "summary": "Operation", "operationId": "operation_suppressions_operations__identity__get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "suppressions:read" ] } }, "/usage": { "get": { "summary": "Usage", "operationId": "usage_usage_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "usage:read" ] } }, "/verification/batches/{identity}": { "get": { "summary": "Status", "operationId": "status_verification_batches__identity__get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read" ] } }, "/verification/batches/{identity}/cancel": { "post": { "summary": "Cancel", "operationId": "cancel_verification_batches__identity__cancel_post", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "audiences:write" ] } }, "/verification/config": { "get": { "summary": "Config", "operationId": "config_verification_config_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read" ] } } }, "components": { "securitySchemes": { "WorkspaceKey": { "type": "http", "scheme": "bearer" } }, "schemas": { "ActivationIn": { "properties": { "id": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Id" }, "desired_daily_sends": { "type": "integer", "maximum": 15000.0, "minimum": 1.0, "title": "Desired Daily Sends" } }, "additionalProperties": false, "type": "object", "required": [ "id", "desired_daily_sends" ], "title": "ActivationIn" }, "ArchiveIn": { "properties": { "id": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Id" }, "expected_revision": { "type": "integer", "minimum": 1.0, "title": "Expected Revision" }, "archived": { "type": "boolean", "title": "Archived" } }, "additionalProperties": false, "type": "object", "required": [ "id", "expected_revision", "archived" ], "title": "ArchiveIn" }, "AssignmentIn": { "properties": { "id": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Id" }, "expected_revision": { "type": "integer", "minimum": 1.0, "title": "Expected Revision" }, "assignee": { "anyOf": [ { "type": "string", "maxLength": 128, "minLength": 1 }, { "type": "null" } ], "title": "Assignee" } }, "additionalProperties": false, "type": "object", "required": [ "id", "expected_revision", "assignee" ], "title": "AssignmentIn" }, "AttachmentIn": { "properties": { "filename": { "type": "string", "maxLength": 104, "minLength": 1, "title": "Filename" }, "content_type": { "type": "string", "title": "Content Type" }, "data_base64": { "type": "string", "maxLength": 87384, "minLength": 1, "title": "Data Base64" } }, "additionalProperties": false, "type": "object", "required": [ "filename", "content_type", "data_base64" ], "title": "AttachmentIn" }, "CampaignIn": { "properties": { "import_digest": { "type": "string", "pattern": "^(?:[0-9a-f]{64})?$", "title": "Import Digest", "default": "" }, "offer": { "type": "string", "maxLength": 10000, "title": "Offer", "default": "" }, "audience_prompt": { "type": "string", "maxLength": 10000, "title": "Audience Prompt", "default": "" }, "id": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Id" }, "name": { "type": "string", "maxLength": 200, "minLength": 1, "title": "Name" }, "steps": { "items": { "$ref": "#/components/schemas/Step" }, "type": "array", "maxItems": 10, "minItems": 1, "title": "Steps" }, "contacts": { "items": { "$ref": "#/components/schemas/Contact" }, "type": "array", "maxItems": 1000, "minItems": 1, "title": "Contacts" }, "schedule": { "$ref": "#/components/schemas/Window" }, "expected_contacts": { "type": "integer", "maximum": 100000.0, "minimum": 0.0, "title": "Expected Contacts", "default": 0 }, "daily_limit": { "type": "integer", "maximum": 15000.0, "minimum": 0.0, "title": "Daily Limit", "default": 0 } }, "additionalProperties": false, "type": "object", "required": [ "id", "name", "steps", "contacts" ], "title": "CampaignIn" }, "CampaignState": { "properties": { "state": { "type": "string", "enum": [ "active", "paused" ], "title": "State" } }, "additionalProperties": false, "type": "object", "required": [ "state" ], "title": "CampaignState" }, "Contact": { "properties": { "email": { "type": "string", "maxLength": 254, "title": "Email" }, "fields": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Fields" } }, "additionalProperties": false, "type": "object", "required": [ "email" ], "title": "Contact" }, "ContactsIn": { "properties": { "contacts": { "items": { "$ref": "#/components/schemas/Contact" }, "type": "array", "maxItems": 1000, "minItems": 1, "title": "Contacts" }, "expected_revision": { "anyOf": [ { "type": "integer", "minimum": 1.0 }, { "type": "null" } ], "title": "Expected Revision" } }, "additionalProperties": false, "type": "object", "required": [ "contacts" ], "title": "ContactsIn" }, "DraftEdit": { "properties": { "expected_revision": { "type": "integer", "minimum": 1.0, "title": "Expected Revision" }, "name": { "type": "string", "maxLength": 200, "minLength": 1, "title": "Name" }, "offer": { "type": "string", "maxLength": 10000, "title": "Offer", "default": "" }, "audience_prompt": { "type": "string", "maxLength": 10000, "title": "Audience Prompt", "default": "" }, "steps": { "items": { "$ref": "#/components/schemas/Step" }, "type": "array", "maxItems": 10, "minItems": 1, "title": "Steps" }, "schedule": { "$ref": "#/components/schemas/Window" }, "daily_limit": { "type": "integer", "maximum": 15000.0, "minimum": 0.0, "title": "Daily Limit", "default": 0 } }, "additionalProperties": false, "type": "object", "required": [ "expected_revision", "name", "steps" ], "title": "DraftEdit" }, "ExclusionBatchIn": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ExclusionIn" }, "type": "array", "maxItems": 200, "minItems": 1, "title": "Items" } }, "additionalProperties": false, "type": "object", "required": [ "items" ], "title": "ExclusionBatchIn" }, "ExclusionIn": { "properties": { "id": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Id" }, "email": { "anyOf": [ { "type": "string", "maxLength": 254, "minLength": 1 }, { "type": "null" } ], "title": "Email" }, "domain": { "anyOf": [ { "type": "string", "maxLength": 253, "minLength": 1 }, { "type": "null" } ], "title": "Domain" }, "reason": { "type": "string", "maxLength": 500, "minLength": 1, "pattern": "\\S", "title": "Reason" }, "evidence": { "type": "string", "maxLength": 2000, "minLength": 1, "pattern": "\\S", "title": "Evidence" } }, "additionalProperties": false, "type": "object", "required": [ "id", "reason", "evidence" ], "title": "ExclusionIn" }, "ExpansionQuote": { "properties": { "id": { "type": "string", "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._~-]*$", "title": "Id" }, "desired_daily_sends": { "type": "integer", "maximum": 15000.0, "minimum": 1.0, "title": "Desired Daily Sends" } }, "additionalProperties": false, "type": "object", "required": [ "id", "desired_daily_sends" ], "title": "ExpansionQuote" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "NoteIn": { "properties": { "id": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Id" }, "expected_revision": { "type": "integer", "minimum": 1.0, "title": "Expected Revision" }, "body": { "type": "string", "maxLength": 10000, "minLength": 1, "pattern": "\\S", "title": "Body" } }, "additionalProperties": false, "type": "object", "required": [ "id", "expected_revision", "body" ], "title": "NoteIn" }, "ReadIn": { "properties": { "through_seq": { "type": "integer", "minimum": 0.0, "title": "Through Seq" } }, "type": "object", "required": [ "through_seq" ], "title": "ReadIn" }, "RefillIn": { "properties": { "id": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Id" }, "expected_audience_revision": { "type": "integer", "minimum": 1.0, "title": "Expected Audience Revision" }, "contacts": { "items": { "$ref": "#/components/schemas/Contact" }, "type": "array", "maxItems": 1000, "minItems": 1, "title": "Contacts" } }, "additionalProperties": false, "type": "object", "required": [ "id", "expected_audience_revision", "contacts" ], "title": "RefillIn" }, "ReplyIn": { "properties": { "id": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Id" }, "message_id": { "type": "string", "maxLength": 256, "minLength": 1, "title": "Message Id" }, "subject": { "type": "string", "maxLength": 500, "minLength": 1, "title": "Subject" }, "body": { "type": "string", "maxLength": 100000, "minLength": 1, "title": "Body" }, "html": { "type": "string", "maxLength": 100000, "title": "Html", "default": "" }, "attachments": { "items": { "$ref": "#/components/schemas/AttachmentIn" }, "type": "array", "maxItems": 3, "title": "Attachments" } }, "additionalProperties": false, "type": "object", "required": [ "id", "message_id", "subject", "body" ], "title": "ReplyIn" }, "ReplyIntentIn": { "properties": { "intent": { "type": "string", "enum": [ "needs_review", "interested", "not_interested", "opt_out", "out_of_office" ], "title": "Intent" }, "expected_revision": { "type": "integer", "minimum": 1.0, "title": "Expected Revision" } }, "additionalProperties": false, "type": "object", "required": [ "intent", "expected_revision" ], "title": "ReplyIntentIn" }, "ReuseIn": { "properties": { "id": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Id" }, "review_id": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Review Id" } }, "additionalProperties": false, "type": "object", "required": [ "id", "review_id" ], "title": "ReuseIn" }, "Review": { "properties": { "id": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Id" }, "revision": { "type": "integer", "minimum": 1.0, "title": "Revision" }, "policy": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Policy" }, "rate_version": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Rate Version" }, "price_cents": { "type": "integer", "maximum": 100000.0, "minimum": 1.0, "title": "Price Cents" }, "maximum_cents": { "type": "integer", "maximum": 1000000000.0, "minimum": 1.0, "title": "Maximum Cents" } }, "additionalProperties": false, "type": "object", "required": [ "id", "revision", "policy", "rate_version", "price_cents", "maximum_cents" ], "title": "Review" }, "StartIn": { "properties": { "id": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Id" }, "review_id": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Review Id" }, "quote_id": { "anyOf": [ { "type": "string", "maxLength": 128, "minLength": 1 }, { "type": "null" } ], "title": "Quote Id" }, "capacity_operation": { "anyOf": [ { "type": "string", "maxLength": 128, "minLength": 1 }, { "type": "null" } ], "title": "Capacity Operation" } }, "additionalProperties": false, "type": "object", "required": [ "id", "review_id" ], "title": "StartIn" }, "StartReviewIn": { "properties": { "id": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Id" }, "expected_revision": { "type": "integer", "minimum": 1.0, "title": "Expected Revision" }, "quote_id": { "anyOf": [ { "type": "string", "maxLength": 128, "minLength": 1 }, { "type": "null" } ], "title": "Quote Id" }, "capacity_operation": { "anyOf": [ { "type": "string", "maxLength": 128, "minLength": 1 }, { "type": "null" } ], "title": "Capacity Operation" } }, "additionalProperties": false, "type": "object", "required": [ "id", "expected_revision" ], "title": "StartReviewIn" }, "StatusIn": { "properties": { "id": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Id" }, "expected_revision": { "type": "integer", "minimum": 1.0, "title": "Expected Revision" }, "status": { "type": "string", "enum": [ "closed", "needs_reply" ], "title": "Status" } }, "additionalProperties": false, "type": "object", "required": [ "id", "expected_revision", "status" ], "title": "StatusIn" }, "Step": { "properties": { "subject": { "type": "string", "maxLength": 500, "minLength": 1, "title": "Subject" }, "body": { "type": "string", "maxLength": 100000, "minLength": 1, "title": "Body" }, "html": { "type": "string", "maxLength": 100000, "title": "Html", "default": "" }, "attachments": { "items": { "$ref": "#/components/schemas/AttachmentIn" }, "type": "array", "maxItems": 3, "title": "Attachments" }, "delay_seconds": { "type": "integer", "maximum": 31536000.0, "minimum": 0.0, "title": "Delay Seconds", "default": 0 } }, "additionalProperties": false, "type": "object", "required": [ "subject", "body" ], "title": "Step" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" }, "input": { "title": "Input" }, "ctx": { "type": "object", "title": "Context" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" }, "Window": { "properties": { "timezone": { "type": "string", "title": "Timezone", "default": "UTC" }, "weekdays": { "items": { "type": "integer" }, "type": "array", "maxItems": 7, "minItems": 1, "title": "Weekdays" }, "start": { "type": "string", "title": "Start", "default": "00:00" }, "end": { "type": "string", "title": "End", "default": "24:00" } }, "additionalProperties": false, "type": "object", "title": "Window" } } } }