{ "openapi": "3.1.0", "info": { "title": "Startwave customer API", "version": "controlled-beta", "description": "Workspace API-key grants with native response contracts. Current projections and immutable operation originals are distinct. Historical operation reads preserve original recovery, not new spending authority; consult the guide for scope and billing boundaries." }, "servers": [ { "url": "https://api.startwave.io" } ], "paths": { "/analytics/delivery": { "get": { "summary": "Delivery Analytics", "operationId": "delivery_analytics_analytics_delivery_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" } }, { "name": "campaign_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Campaign Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliverySummary" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "usage:read" ] } }, "/analytics/delivery-days": { "get": { "summary": "Daily Delivery Analytics", "operationId": "daily_delivery_analytics_analytics_delivery_days_get", "parameters": [ { "name": "start", "in": "query", "required": true, "schema": { "type": "number", "title": "Start" } }, { "name": "end", "in": "query", "required": true, "schema": { "type": "number", "title": "End" } }, { "name": "timezone", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 128, "default": "", "title": "Timezone" } }, { "name": "campaign_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Campaign Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DailyDeliveryDays" } } } }, "409": { "description": "Invalid cohort window/timezone or unavailable campaign; inspect detail.code", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectionConflict" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "usage:read" ] } }, "/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": { "$ref": "#/components/schemas/VerificationCohorts" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "usage:read" ] } }, "/billing/card-setups": { "post": { "summary": "Setup", "operationId": "setup_billing_card_setups_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardSetupResult" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "spending:write" ] } }, "/billing/card-setups/{identity}/complete": { "post": { "summary": "Complete", "operationId": "complete_billing_card_setups__identity__complete_post", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardChangeResult" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "spending:write" ] } }, "/billing/cards": { "get": { "summary": "Cards", "operationId": "cards_billing_cards_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 128, "default": "", "title": "After" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedCards" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "usage:read" ] } }, "/billing/cards/{method}/remove": { "post": { "summary": "Remove", "operationId": "remove_billing_cards__method__remove_post", "parameters": [ { "name": "method", "in": "path", "required": true, "schema": { "type": "string", "title": "Method" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/CardChangeResult" }, { "$ref": "#/components/schemas/CardRemovalRejected" } ], "title": "Response 200 Remove Billing Cards Method Remove Post" }, "examples": { "required_card_rejected": { "summary": "Original removal rejected before any effect; select another primary separately", "value": { "id": "example-remove-required", "method": "pm_exampleRequired", "revision": 7, "completed": false, "outcome": "rejected_no_effect", "reason": "subscription_replace_default_card_first", "replayed": false } }, "same_rejection_after_response_loss": { "summary": "Same original remains rejected; replay does not attempt detachment", "value": { "id": "example-remove-required", "method": "pm_exampleRequired", "revision": 7, "completed": false, "outcome": "rejected_no_effect", "reason": "subscription_replace_default_card_first", "replayed": true } } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "spending:write" ] } }, "/billing/history": { "get": { "summary": "Customer History", "operationId": "customer_history_billing_history_get", "parameters": [ { "name": "start", "in": "query", "required": true, "schema": { "type": "number", "title": "Start" } }, { "name": "end", "in": "query", "required": true, "schema": { "type": "number", "title": "End" } }, { "name": "before", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 2048, "default": "", "title": "Before" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "kind", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 32 }, { "type": "null" } ], "title": "Kind" } }, { "name": "campaign", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ], "title": "Campaign" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingHistoryPage" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "usage:read" ] } }, "/billing/preferences": { "patch": { "summary": "Preferences", "operationId": "preferences_billing_preferences_patch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultCard" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardChangeResult" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "spending:write" ] } }, "/billing/subscription": { "get": { "summary": "Status", "operationId": "status_billing_subscription_get", "parameters": [ { "name": "changes_after", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 128, "default": "", "title": "Changes After" } }, { "name": "invoices_after", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 128, "default": "", "title": "Invoices After" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionSnapshot" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "usage:read" ] } }, "/billing/subscription/changes": { "post": { "summary": "Review", "operationId": "review_billing_subscription_changes_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Review" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionChange" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "spending:write" ] } }, "/billing/subscription/changes/{identity}": { "get": { "summary": "Change", "operationId": "change_billing_subscription_changes__identity__get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionChangeStatus" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "usage:read" ] } }, "/billing/subscription/changes/{identity}/cancel": { "post": { "summary": "Cancel", "operationId": "cancel_billing_subscription_changes__identity__cancel_post", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionSnapshot" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "spending:write" ] } }, "/billing/subscription/changes/{identity}/confirm": { "post": { "summary": "Confirm", "operationId": "confirm_billing_subscription_changes__identity__confirm_post", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Confirmation" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionConfirmation" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "spending:write" ] } }, "/billing/subscription/changes/{identity}/recover": { "post": { "summary": "Recover", "operationId": "recover_billing_subscription_changes__identity__recover_post", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Recovery" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionRecovery" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "spending:write" ] } }, "/billing/top-ups": { "get": { "summary": "Top Ups", "description": "Historical sending-wallet funding, not subscription capacity or metered data funds. New authority is disabled after subscription cutover; retain original read/cancel recovery. Use /billing/subscription for capacity and /v1/billing/data-fundings for metered data.", "operationId": "top_ups_billing_top_ups_get", "deprecated": true, "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 128, "default": "", "title": "After" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyFundingHistory" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "usage:read" ] } }, "/billing/top-ups/{identity}": { "get": { "summary": "Top Up Status", "description": "Historical sending-wallet funding, not subscription capacity or metered data funds. New authority is disabled after subscription cutover; retain original read/cancel recovery. Use /billing/subscription for capacity and /v1/billing/data-fundings for metered data.", "operationId": "top_up_status_billing_top_ups__identity__get", "deprecated": true, "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyFundingResult" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "usage:read" ] } }, "/billing/top-ups/{identity}/cancel": { "post": { "summary": "Cancel Top Up", "description": "Historical sending-wallet funding, not subscription capacity or metered data funds. New authority is disabled after subscription cutover; retain original read/cancel recovery. Use /billing/subscription for capacity and /v1/billing/data-fundings for metered data.", "operationId": "cancel_top_up_billing_top_ups__identity__cancel_post", "deprecated": true, "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyFundingResult" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "spending:write" ] } }, "/billing/top-ups/{identity}/confirm": { "post": { "summary": "Confirm Top Up", "description": "Historical sending-wallet funding, not subscription capacity or metered data funds. New authority is disabled after subscription cutover; retain original read/cancel recovery. Use /billing/subscription for capacity and /v1/billing/data-fundings for metered data.", "operationId": "confirm_top_up_billing_top_ups__identity__confirm_post", "deprecated": true, "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyFundingResult" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "spending:write" ] } }, "/billing/verification-usage": { "get": { "summary": "Customer Verification Usage", "operationId": "customer_verification_usage_billing_verification_usage_get", "parameters": [ { "name": "start", "in": "query", "required": true, "schema": { "type": "number", "title": "Start" } }, { "name": "end", "in": "query", "required": true, "schema": { "type": "number", "title": "End" } }, { "name": "campaign", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ], "title": "Campaign" } }, { "name": "before", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 2048, "default": "", "title": "Before" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 50, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerificationUsagePage" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "usage:read" ] } }, "/campaign-copy-policy": { "get": { "summary": "Copy Policy", "operationId": "copy_policy_campaign_copy_policy_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CopyPolicy" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read" ] } }, "/campaign-copy-preview": { "post": { "summary": "Copy Preview", "operationId": "copy_preview_campaign_copy_preview_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CopyPreviewIn" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CopyPreview" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:write" ] } }, "/campaigns": { "get": { "summary": "Campaigns", "operationId": "campaigns_campaigns_get", "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 4096, "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" } }, { "name": "name_prefix", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200, "description": "Literal ASCII-case-insensitive prefix. A nonempty prefix orders by normalized name then ID ascending; otherwise newest first.", "default": "", "title": "Name Prefix" }, "description": "Literal ASCII-case-insensitive prefix. A nonempty prefix orders by normalized name then ID ascending; otherwise newest first." }, { "name": "state", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "draft", "active", "paused", "complete" ], "type": "string" }, { "type": "null" } ], "description": "Filter by current Campaign state.", "title": "State" }, "description": "Filter by current Campaign state." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignListPage" } } } }, "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": "With operation_id: immutable Result, identical to the draft-operation original. Without it: CampaignCreated stored row; no keyed recovery.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/Result" }, { "$ref": "#/components/schemas/CampaignCreated" } ], "title": "Response Create Campaigns Post" }, "examples": { "empty_keyed_draft": { "summary": "Synthetic empty draft created with operation_id=create-empty. No contact, charge or send. After response loss, GET the original; an exact keyed replay returns this same receipt.", "value": { "operation": { "id": "create-empty", "workspace": "workspace", "campaign": "empty-draft", "action": "create", "request_digest": "48a409ab38799ab2dd66fc587789befc87153409b62f0029f32e6224e74928e5", "actor": "service:1074c3d56ba74f8c5bc2e4d260925e5fc9ec104cc000848b66289d0897c4942a", "expected_revision": null, "before_revision": null, "after_revision": 1, "outcome": "recorded", "state_after": "draft", "counts": { "contacts": 0, "added": 0, "excluded": 0 }, "recorded_at": 1791763200 } } } } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignConflict" } } }, "description": "Conflict" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:write" ] } }, "/campaigns/allocations": { "patch": { "summary": "Update", "operationId": "update_campaigns_allocations_patch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllocationApply" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllocationResult" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:write", "spending:write" ] } }, "/campaigns/allocations/preview": { "post": { "summary": "Inspect", "operationId": "inspect_campaigns_allocations_preview_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllocationPreviewIn" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllocationPreview" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read" ] } }, "/campaigns/allocations/{operation_id}": { "get": { "summary": "Original", "operationId": "original_campaigns_allocations__operation_id__get", "parameters": [ { "name": "operation_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Operation Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllocationResult" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read" ] } }, "/campaigns/schedule-advice": { "post": { "summary": "Read", "operationId": "read_campaigns_schedule_advice_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleAdviceRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleAdviceResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read" ] } }, "/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": { "$ref": "#/components/schemas/CampaignDetail" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read" ] }, "patch": { "summary": "Update", "description": "Atomically save changed fields; published behavior also requires owner and spending:write.\n\nOmission preserves values. Only name_cleaning accepts null (clear). Steps, schedule and\nrecipient field maps replace their respective values. Source selection additionally\nrequires contacts:read. Published behavior includes copy, schedule, policy, recipients\nand source selection. Retained steps keep their IDs; new follow-ups omit id. Array\norder defines the current sequence. Omit a follow-up to remove future mutable work;\naccepted and uncertain originals remain. Step zero stays first. Recent finished people\njoin new follow-ups only while the new wait is still prospective (at most 30 days since\ntheir last accepted touch); completed campaigns still require explicit Resume.\nSave never launches or buys. Later saves coalesce propagation without erasing originals.\nRecover the exact original operation_id after a lost response; do not mint another ID.", "operationId": "update_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/CampaignSave" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveResult" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignConflict" } } }, "description": "Conflict" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-conditional-scopes": { "sources": [ "contacts:read" ], "published_behavior": [ "spending:write" ] }, "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": { "$ref": "#/components/schemas/CampaignAudiencePage" } } } }, "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": { "anyOf": [ { "$ref": "#/components/schemas/Result" }, { "$ref": "#/components/schemas/AppendCounts" } ], "title": "Response Append Contacts Campaigns Cid Contacts Post" }, "examples": { "keyed_append": { "summary": "Synthetic keyed append. Recover this same receipt through draft-operations before replay; current contact totals are not this original.", "value": { "operation": { "id": "append-original", "workspace": "workspace", "campaign": "campaign", "action": "append", "request_digest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "actor": "service:example", "expected_revision": 1, "before_revision": 1, "after_revision": 2, "outcome": "recorded", "state_after": "draft", "counts": { "contacts": 2, "added": 1, "excluded": 0 }, "recorded_at": 1791763200 } } }, "unkeyed_append": { "summary": "Unkeyed append has counts, not an original operation. New clients should use operation_id.", "value": { "added": 1, "contacts": 2, "revision": 2 } } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "audiences:write" ] } }, "/campaigns/{cid}/copy-changes/{identity}": { "get": { "summary": "Inspect", "operationId": "inspect_campaigns__cid__copy_changes__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" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CopyChangeReceipt" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read" ] } }, "/campaigns/{cid}/draft-operations/{identity}": { "get": { "summary": "Original", "operationId": "original_campaigns__cid__draft_operations__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" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" }, "examples": { "recovered_empty_draft": { "summary": "GET /campaigns/empty-draft/draft-operations/create-empty after lost Create response. Matches the original POST receipt, not current Campaign state. Missing original stays unknown; do not generate another operation ID.", "value": { "operation": { "id": "create-empty", "workspace": "workspace", "campaign": "empty-draft", "action": "create", "request_digest": "48a409ab38799ab2dd66fc587789befc87153409b62f0029f32e6224e74928e5", "actor": "service:1074c3d56ba74f8c5bc2e4d260925e5fc9ec104cc000848b66289d0897c4942a", "expected_revision": null, "before_revision": null, "after_revision": 1, "outcome": "recorded", "state_after": "draft", "counts": { "contacts": 0, "added": 0, "excluded": 0 }, "recorded_at": 1791763200 } } } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read" ] } }, "/campaigns/{cid}/eligibility": { "get": { "summary": "Campaign Eligibility", "operationId": "campaign_eligibility_campaigns__cid__eligibility_get", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100000, "minimum": 1, "default": 100000, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignEligibilityBreakdown" }, "examples": { "qualified_and_held": { "summary": "First-email qualification is not sending capacity or confirmed delivery", "value": { "observed_at": 1767240000.0, "complete": true, "inspected": 3, "total": 3, "counts": { "qualified": 1, "preparing": 0, "waiting": 1, "ineligible": 1, "contacted": 0, "stopped": 0, "needs_review": 0 }, "reason_counts": { "recontact_cooldown": 1, "catch_all_not_allowed": 1 }, "contacted_total": 0, "queued_followups": 0, "qualified_upper_bound": 1, "recontact_days": 30, "semantics": "first_email_qualification_not_send_capacity" } } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read" ] } }, "/campaigns/{cid}/launch": { "post": { "summary": "Launch Campaign", "operationId": "launch_campaign_campaigns__cid__launch_post", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LaunchIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LaunchResult" }, "examples": { "started": { "summary": "Synthetic original launch receipt; started is not delivery.", "value": { "id": "launch-original", "campaign": "campaign", "state": "started", "campaign_revision": 3, "capacity_operation": "in_original", "send_price_cents": 0, "send_budget_cents": 0, "commercial_policy_version": "startwave-core-v1", "started_at": 1791633600 } } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-conditional-scopes": { "review.source_intake": [ "contacts:read", "contacts:write", "audiences:write", "data:purchase" ] }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:write", "spending:write" ] } }, "/campaigns/{cid}/launches/{identity}": { "get": { "summary": "Launch Receipt", "operationId": "launch_receipt_campaigns__cid__launches__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" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LaunchResult" }, "examples": { "started": { "summary": "Recovery returns the same original, not a new launch.", "value": { "id": "launch-original", "campaign": "campaign", "state": "started", "campaign_revision": 3, "capacity_operation": "in_original", "send_price_cents": 0, "send_budget_cents": 0, "commercial_policy_version": "startwave-core-v1", "started_at": 1791633600 } } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read" ] } }, "/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": { "$ref": "#/components/schemas/MaterializationStatus" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read" ] } }, "/campaigns/{cid}/name-quality": { "get": { "summary": "Read", "operationId": "read_campaigns__cid__name_quality_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": 200, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "state", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "unchecked", "ready", "pending", "held", "unavailable" ], "type": "string" }, { "type": "null" } ], "title": "State" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Quality" } } } }, "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", "maximum": 9007199254740991, "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": { "$ref": "#/components/schemas/RefillHistory" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read" ] } }, "/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": { "$ref": "#/components/schemas/RefillResult" }, "examples": { "recovered_refill": { "summary": "Original after response loss; identical to POST, not another append. Invalid row content is absent.", "value": { "id": "refill-original", "campaign": "campaign", "added": 1, "duplicates": 1, "suppressed": 0, "conflicting": 0, "invalid": 1, "submitted": 3, "errors": [ { "index": 2, "reason": "invalid_email" } ], "next_error_cursor": null, "audience_revision": 2, "send_budget_added_cents": 0, "send_budget_cents": null, "actor": "service:example", "created_at": 1791763200 } } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read" ] } }, "/campaigns/{cid}/reply-budget": { "post": { "summary": "Reply Budget", "operationId": "reply_budget_campaigns__cid__reply_budget_post", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplyBudgetIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplyBudgetOriginal" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "inbox:write", "spending:write" ] } }, "/campaigns/{cid}/reply-budget-reviews": { "get": { "summary": "Reply Budget Reviews", "operationId": "reply_budget_reviews_campaigns__cid__reply_budget_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": { "$ref": "#/components/schemas/ReplyBudgetPage" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "inbox:read" ] } }, "/campaigns/{cid}/saves/{identity}": { "get": { "summary": "Original", "operationId": "original_campaigns__cid__saves__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" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveResult" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read" ] } }, "/campaigns/{cid}/schedule-changes/{identity}": { "get": { "summary": "Inspect", "operationId": "inspect_campaigns__cid__schedule_changes__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" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleChangeReceipt" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read" ] } }, "/campaigns/{cid}/send-events/{event}": { "get": { "summary": "Inspect Event", "operationId": "inspect_event_campaigns__cid__send_events__event__get", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } }, { "name": "event", "in": "path", "required": true, "schema": { "type": "integer", "title": "Event" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordedSend" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read" ] } }, "/campaigns/{cid}/send-plan/{identity}": { "get": { "summary": "Inspect", "operationId": "inspect_campaigns__cid__send_plan__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" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendDetail" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read" ] } }, "/campaigns/{cid}/send-readiness": { "get": { "summary": "Readiness", "operationId": "readiness_campaigns__cid__send_readiness_get", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 4096, "default": "", "title": "Cursor" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 25, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReadinessPage" } } } }, "409": { "description": "Invalid or expired readiness cursor, or unavailable campaign; inspect detail.code", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectionConflict" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read" ] } }, "/campaigns/{cid}/source-admission-reviews/by-key": { "get": { "summary": "Review By Key", "operationId": "review_by_key_campaigns__cid__source_admission_reviews_by_key_get", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } }, { "name": "key", "in": "query", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "title": "Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdmissionReview" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read", "contacts:read" ] } }, "/campaigns/{cid}/source-admission-reviews/{identity}": { "get": { "summary": "Review Original", "operationId": "review_original_campaigns__cid__source_admission_reviews__identity__get", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } }, { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdmissionReview" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read", "contacts:read" ] } }, "/campaigns/{cid}/source-admissions": { "get": { "summary": "History", "operationId": "history_campaigns__cid__source_admissions_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": 50, "minimum": 1, "default": 20, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdmissionHistoryPage" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read", "contacts:read" ] }, "post": { "summary": "Confirm", "operationId": "confirm_campaigns__cid__source_admissions_post", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9_-]+$", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdmissionConfirmIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdmissionResult" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "audiences:write", "spending:write", "contacts:read" ] } }, "/campaigns/{cid}/source-admissions/by-key": { "get": { "summary": "Result By Key", "operationId": "result_by_key_campaigns__cid__source_admissions_by_key_get", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } }, { "name": "key", "in": "query", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "title": "Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdmissionResult" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read", "contacts:read" ] } }, "/campaigns/{cid}/source-admissions/{identity}": { "get": { "summary": "Result Original", "operationId": "result_original_campaigns__cid__source_admissions__identity__get", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } }, { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdmissionResult" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read", "contacts:read" ] } }, "/campaigns/{cid}/source-operations/by-key": { "get": { "summary": "By Key", "operationId": "by_key_campaigns__cid__source_operations_by_key_get", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } }, { "name": "key", "in": "query", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "title": "Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceOperation" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read", "contacts:read" ] } }, "/campaigns/{cid}/source-operations/{identity}": { "get": { "summary": "Original", "operationId": "original_campaigns__cid__source_operations__identity__get", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } }, { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceOperation" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read", "contacts:read" ] } }, "/campaigns/{cid}/source-refills": { "get": { "summary": "History", "operationId": "history_campaigns__cid__source_refills_get", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } }, { "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": { "$ref": "#/components/schemas/RefillPage" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read", "contacts:read" ] }, "post": { "summary": "Create", "operationId": "create_campaigns__cid__source_refills_post", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9_-]+$", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefillConsentIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefillConsent" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:write", "spending:write", "audiences:write", "contacts:read" ] } }, "/campaigns/{cid}/source-refills/by-key": { "get": { "summary": "Original", "operationId": "original_campaigns__cid__source_refills_by_key_get", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } }, { "name": "key", "in": "query", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "title": "Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefillConsent" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read", "contacts:read" ] } }, "/campaigns/{cid}/source-refills/{identity}": { "get": { "summary": "Status", "operationId": "status_campaigns__cid__source_refills__identity__get", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } }, { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefillConsent" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read", "contacts:read" ] } }, "/campaigns/{cid}/source-refills/{identity}/cancel": { "post": { "summary": "Cancel", "operationId": "cancel_campaigns__cid__source_refills__identity__cancel_post", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } }, { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefillConsent" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:write", "audiences:write", "contacts:read" ] } }, "/campaigns/{cid}/sources": { "get": { "summary": "Sources", "operationId": "sources_campaigns__cid__sources_get", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceCollection" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read", "contacts:read" ] }, "post": { "summary": "Connect", "description": "Connect a List; published campaigns require owner authority and key spending:write.\n\nConnections do not authorize intake, purchases or sends. Recover an exact original\nbefore repeating a mutation; original reads do not require new-change authority.", "operationId": "connect_campaigns__cid__sources_post", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9_-]+$", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceConnect" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceOperation" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-conditional-scopes": { "published_campaign": [ "spending:write" ] }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:write", "contacts:read" ] } }, "/campaigns/{cid}/sources/{identity}": { "patch": { "summary": "Edit", "description": "Edit a List connection; published campaigns require owner authority and key spending:write.\n\nDraft operators retain connection editing. Existing original-operation reads remain\navailable under their ordinary scopes; this change never launches or broadens consent.", "operationId": "edit_campaigns__cid__sources__identity__patch", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } }, { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9_-]+$", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceEdit" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceOperation" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-conditional-scopes": { "published_campaign": [ "spending:write" ] }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:write", "contacts: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": { "$ref": "#/components/schemas/CurrentCampaignStart" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read" ] } }, "/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": { "$ref": "#/components/schemas/StartReview" }, "examples": { "subscription": { "summary": "Synthetic funded subscription review; values are observations, not client constants.", "value": { "id": "review-original", "kind": "start", "commercial_policy_version": "startwave-core-v1", "spending_mode": "capacity", "schedule": { "definition": "campaign-pacing-upper-bound-v1", "observed_at": 1791633600, "local_date": "2026-10-10", "timezone": "America/New_York", "first_eligible_at": 1791633600, "opens_at": 1791604800, "closes_at": 1791691200, "nominal_gap_seconds": 1920, "daily_limit": 45, "quota_used": 0, "quota_remaining": 45, "pacing_slots_upper_bound": 30, "completion_guaranteed": false }, "campaign": "campaign", "campaign_revision": 2, "capacity": { "quote_id": null, "capacity_operation": "in_original", "period_seconds": 2592000, "rate_cents_per_block": 3750, "rate_version": "subscription-30d-v1", "maximum_new_capacity_cents": 0, "daily_capacity": 90, "expires_at": 1794225540, "billing_mode": "subscription-30d-v1", "renewal": { "revision": 1, "enabled": true, "recurring_max_cents": 7500 } }, "audience_revision": 1, "remaining_send_count": 4, "state": "reviewed", "send_price_cents": 0, "send_budget_cents": 0, "audience_count": 2, "sequence_steps": 2, "send_committed_cents": 0, "reviewed_at": 1791633600, "reviewed_by": "service:example" } } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-conditional-scopes": { "source_refill": [ "contacts:read", "contacts:write", "audiences:write", "data:purchase" ] }, "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": { "$ref": "#/components/schemas/StartReviewPage" } } } }, "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": "Current Campaign after the requested state change; not an immutable Pause original. Resume requires the reviewed Launch owner under paid configuration.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignCreated" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:write" ] } }, "/campaigns/{cid}/summary": { "get": { "summary": "Read Campaign Summary", "operationId": "read_campaign_summary_campaigns__cid__summary_get", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignSummary" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read" ] } }, "/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": { "$ref": "#/components/schemas/CampaignVerificationPage" } } } }, "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": { "$ref": "#/components/schemas/CurrentVerificationBatch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read" ] } }, "/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": { "$ref": "#/components/schemas/CampaignWindowsPage" } } } }, "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": { "$ref": "#/components/schemas/CurrentCapacity" } } } } }, "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": { "$ref": "#/components/schemas/CapacityExpansionResponse" } } } }, "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": { "$ref": "#/components/schemas/CapacityExpansionResponse" } } } }, "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", "description": "New legacy expansion confirmation is retired under subscription billing. An already-submitted original continues its recovery on replay.", "operationId": "confirm_capacity_expansions__identity__confirm_post", "deprecated": true, "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CapacityExpansionResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:write", "spending:write" ] } }, "/capacity/lease-health": { "get": { "summary": "Customer", "operationId": "customer_capacity_lease_health_get", "parameters": [ { "name": "operation", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 128, "default": "", "title": "Operation" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 2048, "default": "", "title": "Cursor" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 50, "minimum": 1, "default": 25, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeaseHealthPage" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "usage:read" ] } }, "/capacity/limit": { "get": { "summary": "Read", "operationId": "read_capacity_limit_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 128, "default": "", "title": "After" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountLimit" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "usage:read" ] } }, "/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": { "$ref": "#/components/schemas/CapacityPage_CapacityOperation_" } } } }, "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": { "$ref": "#/components/schemas/CapacityPage_CapacityExpansionResponse_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "usage:read" ] } }, "/capacity/operations/{operation}": { "get": { "summary": "Capacity Operation", "description": "Read the original funded term and its recovery state, including retired legacy operations.", "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": { "$ref": "#/components/schemas/CapacityOperation" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "usage:read" ] } }, "/capacity/operations/{operation}/reactivations": { "get": { "summary": "List Reactivations", "operationId": "list_reactivations_capacity_operations__operation__reactivations_get", "parameters": [ { "name": "operation", "in": "path", "required": true, "schema": { "type": "string", "title": "Operation" } }, { "name": "before", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 128, "default": "", "title": "Before" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 50, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CapacityPage_CapacityReactivationResponse_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "usage:read" ] } }, "/capacity/reactivations/{identity}": { "get": { "summary": "Get Reactivation", "operationId": "get_reactivation_capacity_reactivations__identity__get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CapacityReactivationResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "usage:read" ] } }, "/capacity/reactivations/{identity}/cancel": { "post": { "summary": "Cancel Reactivation", "operationId": "cancel_reactivation_capacity_reactivations__identity__cancel_post", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CapacityReactivationResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:write" ] } }, "/capacity/reactivations/{identity}/confirm": { "post": { "summary": "Confirm Reactivation", "description": "New legacy confirmation is retired under subscription billing. An already-submitted original continues its recovery on replay.", "operationId": "confirm_reactivation_capacity_reactivations__identity__confirm_post", "deprecated": true, "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CapacityReactivationResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:write", "spending:write" ] } }, "/capacity/requests/{identity}": { "get": { "summary": "Read Request", "description": "Read an immutable legacy review, preparation blocker or original confirmation recovery state.", "operationId": "read_request_capacity_requests__identity__get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/CapacityRequestReview" }, { "$ref": "#/components/schemas/CapacityRequestConfirmation" }, { "$ref": "#/components/schemas/CapacityRequestIncomplete" } ], "title": "Response 200 Read Request Capacity Requests Identity Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "usage:read" ] } }, "/capacity/requests/{identity}/confirm": { "post": { "summary": "Confirm Request", "description": "New legacy confirmation is retired under subscription billing. Replay of an already-confirmed original continues its recovery.", "operationId": "confirm_request_capacity_requests__identity__confirm_post", "deprecated": true, "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CapacityConsentIn", "default": {} } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CapacityRequestConfirmation" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:write", "spending:write" ] } }, "/compliance": { "get": { "summary": "Read", "operationId": "read_compliance_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComplianceStatus" } } } } }, "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", "handed_off" ], "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" } }, { "name": "read", "in": "query", "required": false, "schema": { "enum": [ "all", "read", "unread" ], "type": "string", "default": "all", "title": "Read" } }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 100, "default": "", "title": "Q" } }, { "name": "intent", "in": "query", "required": false, "schema": { "enum": [ "all", "needs_review", "interested", "not_interested", "opt_out", "out_of_office", "automated", "recipient_unavailable" ], "type": "string", "default": "all", "title": "Intent" } }, { "name": "attention", "in": "query", "required": false, "schema": { "enum": [ "all", "needs_person" ], "type": "string", "default": "all", "title": "Attention" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationPage" }, "examples": { "unread_reply": { "summary": "Synthetic list page; unread is an integer, next_cursor is nullable and not a total.", "value": { "items": [ { "workspace": "one", "id": "conversation-example", "last_activity": 1791633600, "last_inbound_seq": 1, "status": "needs_reply", "revision": 2, "assignee": null, "archived": 0, "has_sent": 0, "email": "one@example.test", "campaign": "campaign-one", "campaign_name": "campaign-one", "unread": 1, "attention_seq": 1, "handoff": null, "inbox": { "workflow": "needs_reply", "reply_delivery": "none", "intent": "needs_review" } } ], "next_cursor": null } } } } } }, "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", "maximum": 9007199254740991, "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": { "$ref": "#/components/schemas/ConversationDetail" }, "examples": { "unread_reply": { "summary": "Synthetic inbound-only detail; optional source/classification fields are omitted when absent.", "value": { "conversation": { "workspace": "one", "id": "conversation-example", "last_activity": 1791633600, "last_inbound_seq": 1, "status": "needs_reply", "revision": 2, "assignee": null, "archived": 0, "has_sent": 0, "email": "one@example.test", "campaign": "campaign-one", "attention_seq": 1, "handoff": null, "inbox": { "workflow": "needs_reply", "reply_delivery": "none", "intent": "needs_review" }, "unread": 1 }, "followups": { "state": "inactive", "next_eligible_at": null, "step": null, "stop_id": null, "stopped_at": null, "can_stop": false }, "read_by": [], "read_by_more": false, "items": [ { "seq": 1, "direction": "in", "authorship": "external", "occurred_at": 1791633600, "event_id": "one-a", "message_id": "", "kind": "reply", "content": "Thanks", "intent": "needs_review", "revision": 1, "delivery_action": null, "delivery_status": null, "delivery_confidence": null, "participants": null } ], "next_cursor": null } }, "unknown_reply": { "summary": "Synthetic unresolved outbound reply; retain the original job, never resubmit it under a new ID.", "value": { "conversation": { "workspace": "one", "id": "conversation-example", "last_activity": 1791633600, "last_inbound_seq": 1, "status": "needs_reply", "revision": 2, "assignee": null, "archived": 0, "has_sent": 0, "email": "one@example.test", "campaign": "campaign-one", "attention_seq": 1, "handoff": null, "inbox": { "workflow": "needs_reply", "reply_delivery": "unconfirmed", "intent": "needs_review" }, "unread": 1 }, "followups": { "state": "inactive", "next_eligible_at": null, "step": null, "stop_id": null, "stopped_at": null, "can_stop": false }, "read_by": [], "read_by_more": false, "items": [ { "seq": 2, "direction": "out", "authorship": "human", "occurred_at": 1791633600, "job_id": "reply-original", "submitted_by": "service", "message_id": "", "state": "unknown", "error": "", "subject": "Re: Hello", "content": "Thanks for your reply.", "has_html": false, "attachments": [] }, { "seq": 1, "direction": "in", "authorship": "external", "occurred_at": 1791633600, "event_id": "one-a", "message_id": "", "kind": "reply", "content": "Thanks", "intent": "needs_review", "revision": 1, "delivery_action": null, "delivery_status": null, "delivery_confidence": null, "participants": null } ], "next_cursor": null } } } } } }, "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": { "$ref": "#/components/schemas/ConversationArchive" } } } }, "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", "maximum": 9007199254740991, "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": { "$ref": "#/components/schemas/ConversationHistory_ConversationArchive_" } } } }, "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": { "$ref": "#/components/schemas/ConversationAssignment" } } } }, "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", "maximum": 9007199254740991, "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": { "$ref": "#/components/schemas/ConversationHistory_ConversationAssignment_" } } } }, "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", "maximum": 9007199254740991, "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": { "$ref": "#/components/schemas/ConversationHistory_ConversationChange_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "inbox:read" ] } }, "/conversations/{identity}/do-not-contact": { "post": { "summary": "Do Not Contact", "operationId": "do_not_contact_conversations__identity__do_not_contact_post", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DoNotContactIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationDoNotContact" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "inbox:write" ] } }, "/conversations/{identity}/messages/{event}/attachments/{part}": { "get": { "summary": "Attachment Download", "operationId": "attachment_download_conversations__identity__messages__event__attachments__part__get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } }, { "name": "event", "in": "path", "required": true, "schema": { "type": "string", "title": "Event" } }, { "name": "part", "in": "path", "required": true, "schema": { "type": "integer", "maximum": 200, "minimum": 0, "title": "Part" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "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", "maximum": 9007199254740991, "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": { "$ref": "#/components/schemas/ConversationHistory_ConversationNote_" } } } }, "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": { "$ref": "#/components/schemas/ConversationNote" } } } }, "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": { "$ref": "#/components/schemas/ConversationRead" } } } }, "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": { "$ref": "#/components/schemas/ConversationChange" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "inbox:write" ] } }, "/conversations/{identity}/stop-followups": { "post": { "summary": "Stop Followups", "operationId": "stop_followups_conversations__identity__stop_followups_post", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StopFollowupsIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationStop" } } } }, "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": { "$ref": "#/components/schemas/InboxPage" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "inbox:read" ] } }, "/inbox/review": { "get": { "summary": "Reply Review Queue", "description": "Page recorded reply intents without making mutable intent part of the ordering key.", "operationId": "reply_review_queue_inbox_review_get", "parameters": [ { "name": "before", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 2048, "default": "", "title": "Before" } }, { "name": "intent", "in": "query", "required": false, "schema": { "enum": [ "all", "needs_review", "interested", "not_interested", "opt_out", "out_of_office", "automated", "recipient_unavailable" ], "type": "string", "default": "needs_review", "title": "Intent" } }, { "name": "archive", "in": "query", "required": false, "schema": { "enum": [ "current", "archived", "all" ], "type": "string", "default": "current", "title": "Archive" } }, { "name": "pending", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Pending" } }, { "name": "read", "in": "query", "required": false, "schema": { "enum": [ "all", "read", "unread" ], "type": "string", "default": "all", "title": "Read" } }, { "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": { "$ref": "#/components/schemas/ReplyReviewQueue" }, "examples": { "unclassified": { "summary": "Synthetic intent review with unavailable classifier evidence; not an empty or successful classification.", "value": { "items": [ { "event_id": "one-a", "intent": "needs_review", "revision": 1, "received_at": 1791633600, "conversation": "conversation-example", "status": "needs_reply", "conversation_revision": 2, "last_inbound_seq": 1, "attention_seq": 1, "archived": 0, "unread": 1, "email": "one@example.test", "campaign": "campaign-one", "campaign_name": "campaign-one", "classifier_state": null, "suggestion": null, "choice_confidence": null, "explicit_opt_out": null, "classifier_error": null, "classifier_updated_at": null, "classifier_origin": null, "reason": null, "probabilities": null } ], "next_cursor": null, "review_revision": 1 } } } } } }, "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": { "$ref": "#/components/schemas/IntentResult" } } } }, "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": { "$ref": "#/components/schemas/RetryPage" } } } }, "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": "Historical sending-wallet entries, not subscription invoices or the contact data balance. Use /billing/history for bounded date-filtered reads.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LedgerPage" } } } }, "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": { "$ref": "#/components/schemas/WorkspaceMembers" } } } }, "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": { "$ref": "#/components/schemas/ReplyResult" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "inbox:write", "spending:write" ] } }, "/replies/{jid}/review": { "post": { "summary": "Reply Review", "operationId": "reply_review_replies__jid__review_post", "parameters": [ { "name": "jid", "in": "path", "required": true, "schema": { "type": "string", "title": "Jid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplyReviewReceipt" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "inbox:write", "spending:write" ] } }, "/replies/{jid}/reviews": { "get": { "summary": "History", "operationId": "history_replies__jid__reviews_get", "parameters": [ { "name": "jid", "in": "path", "required": true, "schema": { "type": "string", "title": "Jid" } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 9007199254740991, "minimum": 0, "default": 0, "title": "After" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 50, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplyReviewHistory" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "inbox:read" ] } }, "/send-calendar": { "get": { "summary": "Customer Calendar", "operationId": "customer_calendar_send_calendar_get", "parameters": [ { "name": "start", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time", "title": "Start" } }, { "name": "end", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time", "title": "End" } }, { "name": "timezone", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 128, "default": "", "title": "Timezone" } }, { "name": "campaign", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 128, "default": "", "title": "Campaign" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 4096, "default": "", "title": "Cursor" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "view", "in": "query", "required": false, "schema": { "enum": [ "all", "history", "planned" ], "type": "string", "default": "all", "title": "View" } }, { "name": "projection", "in": "query", "required": false, "schema": { "enum": [ "eligibility", "estimated" ], "type": "string", "default": "eligibility", "title": "Projection" } }, { "name": "partition", "in": "query", "required": false, "schema": { "enum": [ "range", "day" ], "type": "string", "default": "range", "title": "Partition" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalendarPage" } } } }, "409": { "description": "Invalid range/timezone/cursor, changed estimate or unavailable campaign; inspect detail.code", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectionConflict" } } } }, "503": { "description": "Read capacity or storage temporarily unavailable; inspect detail.code and Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectionConflict" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Pagination exception: partition=day returns bounded rows independently for each local day. The root next_cursor is null even when a day has has_more=true. To continue that day, request its local start/end boundaries with partition=range and the same timezone, campaign, view and projection filters, then follow the returned next_cursor with those day-range parameters unchanged until it is null. A null root cursor on partition=day does not mean all day rows have been loaded.", "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read" ] } }, "/sender-identities": { "get": { "summary": "Identities", "operationId": "identities_sender_identities_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": 100, "minimum": 1, "default": 50, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SenderIdentityPage" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read" ] } }, "/starts/{identity}": { "get": { "summary": "Start Status", "description": "Read an original legacy Start and any retained-capacity recovery options.", "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": { "$ref": "#/components/schemas/CampaignStartResponse" } } } }, "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": { "$ref": "#/components/schemas/CampaignStartResponse" } } } }, "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": { "$ref": "#/components/schemas/CapacityRelease" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns: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": { "$ref": "#/components/schemas/ExclusionPage" } } } }, "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": { "$ref": "#/components/schemas/ExclusionOriginal" } } } }, "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": { "$ref": "#/components/schemas/ExclusionResults" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "suppressions:write" ] } }, "/suppressions/export": { "get": { "summary": "Export", "description": "Download one bounded CSV page of workspace exclusions. Pass X-Next-Cursor as after for the next page. Formula-leading CSV cells are escaped; GET /suppressions provides the lossless JSON alternative with the same scope and keyset cursor.", "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": "CSV page ordered by the excluded email or domain.", "content": { "text/csv": { "schema": { "type": "string" } } }, "headers": { "Content-Disposition": { "description": "Attachment filename for the selected scope.", "schema": { "type": "string" } }, "X-Next-Cursor": { "description": "Pass as after to continue; empty at the end of the list.", "schema": { "type": "string" } }, "X-Export-Consistency": { "description": "Live keyset traversal, not a frozen snapshot.", "schema": { "type": "string", "enum": [ "live-keyset" ] } } } }, "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", "maximum": 9007199254740991, "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": { "$ref": "#/components/schemas/ExclusionHistory" } } } }, "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": { "$ref": "#/components/schemas/ExclusionOriginal" } } } }, "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": "Sending-wallet projection with at most 100 recent entries. Not the sending subscription, data balance or an all-time ledger page.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletUsage" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "usage:read" ] } }, "/v1/accounts": { "get": { "summary": "Companies", "operationId": "companies_v1_accounts_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": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "state", "in": "query", "required": false, "schema": { "enum": [ "active", "archived" ], "type": "string", "default": "active", "title": "State" } }, { "name": "name_prefix", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200, "default": "", "title": "Name Prefix" } }, { "name": "sort", "in": "query", "required": false, "schema": { "enum": [ "id", "name", "updated_at" ], "type": "string", "default": "id", "title": "Sort" } }, { "name": "order", "in": "query", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string", "default": "asc", "title": "Order" } }, { "name": "ownership", "in": "query", "required": false, "schema": { "enum": [ "all", "net_new", "saved" ], "type": "string", "default": "all", "title": "Ownership" } }, { "name": "list_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[a-f0-9]{32}$" }, { "type": "null" } ], "title": "List Id" } }, { "name": "data_access", "in": "query", "required": false, "schema": { "anyOf": [ { "const": "licensed", "type": "string" }, { "type": "null" } ], "description": "Only records with a selected licensed snapshot in this workspace; email availability is irrelevant.", "title": "Data Access" }, "description": "Only records with a selected licensed snapshot in this workspace; email availability is irrelevant." }, { "name": "source_freshness", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "current", "update_available", "unavailable" ], "type": "string" }, { "type": "null" } ], "title": "Source Freshness" } }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200, "description": "Literal Unicode-folded substring over permitted saved or selected owned fields. Examines at most 1000 indexed candidates; follow next_cursor even on empty pages.", "default": "", "title": "Q" }, "description": "Literal Unicode-folded substring over permitted saved or selected owned fields. Examines at most 1000 indexed candidates; follow next_cursor even on empty pages." }, { "name": "COMPANY_DOMAIN", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 253 }, { "type": "null" } ], "title": "Company Domain" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_CompanyView_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:read" ] }, "post": { "summary": "Create Company", "operationId": "create_company_v1_accounts_post", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9_-]+$", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyData" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Operation" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:write" ] } }, "/v1/accounts/from-search": { "post": { "summary": "Save Company", "operationId": "save_company_v1_accounts_from_search_post", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9_-]+$", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveCompanySource" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Operation" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:write" ] } }, "/v1/accounts/lookup": { "post": { "summary": "Lookup Companies", "operationId": "lookup_companies_v1_accounts_lookup_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordLookup" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LookupResult_CompanyView_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:read" ] } }, "/v1/accounts/{identity}": { "get": { "summary": "Company", "operationId": "company_v1_accounts__identity__get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[^\\x00-\\x1f\\x7f]+$", "title": "Identity" } }, { "name": "id_type", "in": "query", "required": false, "schema": { "enum": [ "source", "record" ], "type": "string", "default": "record", "title": "Id Type" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:read" ] }, "patch": { "summary": "Edit Company", "operationId": "edit_company_v1_accounts__identity__patch", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9_-]+$", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyEdit" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Operation" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:write" ] } }, "/v1/accounts/{identity}/preview-refreshes": { "post": { "summary": "Refresh Company", "operationId": "refresh_company_v1_accounts__identity__preview_refreshes_post", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9_-]+$", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreviewRefresh" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Operation" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:write" ] } }, "/v1/accounts/{identity}/source-checks": { "get": { "summary": "Company History", "operationId": "company_history_v1_accounts__identity__source_checks_get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 9007199254740991, "minimum": 0, "default": 0, "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": { "$ref": "#/components/schemas/SourceCheckHistory" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:read" ] }, "post": { "summary": "Check Company", "operationId": "check_company_v1_accounts__identity__source_checks_post", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9_-]+$", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceCheck" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Operation" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:write" ] } }, "/v1/billing/data-autopay": { "get": { "summary": "Get", "operationId": "get_v1_billing_data_autopay_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateView" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "billing:read" ] }, "patch": { "summary": "Update", "operationId": "update_v1_billing_data_autopay_patch", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9_-]+$", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateChange" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "billing:write", "spending:write" ] } }, "/v1/billing/data-balance": { "get": { "summary": "Balance", "operationId": "balance_v1_billing_data_balance_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataBalance" }, "examples": { "pending_card_bonus": { "summary": "Only available money is spendable; adding a verified card earns the separate bonus without enabling top-up", "value": { "currency": "usd", "available_minor": 500, "promotional_minor": 500, "debt_minor": 0, "purchase_blocked": false, "signup_bonus": { "card_bonus_minor": 500, "card_bonus_state": "pending" } } } } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "billing:read" ] } }, "/v1/billing/data-funding-reviews": { "post": { "summary": "Review", "operationId": "review_v1_billing_data_funding_reviews_post", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9_-]+$", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FundingAmount" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FundingReview" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "billing:write", "spending:write" ] } }, "/v1/billing/data-funding-reviews/by-key": { "get": { "summary": "Review By Key", "operationId": "review_by_key_v1_billing_data_funding_reviews_by_key_get", "parameters": [ { "name": "key", "in": "query", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "title": "Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FundingReview" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "billing:read" ] } }, "/v1/billing/data-funding-reviews/{identity}": { "get": { "summary": "Review Original", "operationId": "review_original_v1_billing_data_funding_reviews__identity__get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FundingReview" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "billing:read" ] } }, "/v1/billing/data-fundings": { "get": { "summary": "History", "operationId": "history_v1_billing_data_fundings_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 32, "default": "", "title": "After" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FundingHistory" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "billing:read" ] }, "post": { "summary": "Confirm", "operationId": "confirm_v1_billing_data_fundings_post", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9_-]+$", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FundingConfirmation" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FundingView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "billing:write", "spending:write" ] } }, "/v1/billing/data-fundings/by-key": { "get": { "summary": "By Key", "operationId": "by_key_v1_billing_data_fundings_by_key_get", "parameters": [ { "name": "key", "in": "query", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "title": "Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FundingView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "billing:read" ] } }, "/v1/billing/data-fundings/{identity}": { "get": { "summary": "Original", "operationId": "original_v1_billing_data_fundings__identity__get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FundingView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "billing:read" ] } }, "/v1/billing/data-fundings/{identity}/cancel": { "post": { "summary": "Cancel", "operationId": "cancel_v1_billing_data_fundings__identity__cancel_post", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FundingView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "billing:write", "spending:write" ] } }, "/v1/billing/data-fundings/{identity}/confirm": { "post": { "summary": "Confirmation", "operationId": "confirmation_v1_billing_data_fundings__identity__confirm_post", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FundingConfirmation" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FundingView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "billing:write", "spending:write" ] } }, "/v1/billing/data-usage": { "get": { "summary": "Usage", "operationId": "usage_v1_billing_data_usage_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 128, "default": "", "title": "After" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataUsage" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "billing:read" ] } }, "/v1/companies/lookup": { "post": { "summary": "Lookup Companies", "operationId": "lookup_companies_v1_companies_lookup_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceLookup" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LookupResult_CompanyPreview_" } } } }, "429": { "description": "Workspace discovery or request capacity exhausted; preserve the query and offer explicit retry.", "headers": { "Retry-After": { "description": "Seconds until retry may be attempted.", "schema": { "type": "integer", "minimum": 1.0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchRateLimit" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "search:read" ] } }, "/v1/companies/resolve": { "post": { "summary": "Resolve Companies", "operationId": "resolve_companies_v1_companies_resolve_post", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9_-]+$" }, { "type": "null" } ], "description": "Required for multiple inputs; preserves the frozen result across retries.", "title": "Idempotency-Key" }, "description": "Required for multiple inputs; preserves the frozen result across retries." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolveRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolvePage" } } } }, "429": { "description": "Workspace discovery or request capacity exhausted; preserve the query and offer explicit retry.", "headers": { "Retry-After": { "description": "Seconds until retry may be attempted.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchRateLimit" } } } }, "202": { "description": "Matching continues on the same result set. Repeat the same body and Idempotency-Key to read progress without starting another lookup.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolvePage" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "search:read" ] } }, "/v1/companies/{identity}": { "get": { "summary": "Company", "operationId": "company_v1_companies__identity__get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[^\\x00-\\x1f\\x7f]+$", "title": "Identity" } }, { "name": "id_type", "in": "query", "required": false, "schema": { "enum": [ "source", "record" ], "type": "string", "default": "source", "title": "Id Type" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyPreview" } } } }, "429": { "description": "Workspace discovery or request capacity exhausted; preserve the query and offer explicit retry.", "headers": { "Retry-After": { "description": "Seconds until retry may be attempted.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchRateLimit" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "search:read" ] } }, "/v1/contacts": { "get": { "summary": "People", "operationId": "people_v1_contacts_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": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "state", "in": "query", "required": false, "schema": { "enum": [ "active", "archived" ], "type": "string", "default": "active", "title": "State" } }, { "name": "name_prefix", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200, "default": "", "title": "Name Prefix" } }, { "name": "sort", "in": "query", "required": false, "schema": { "enum": [ "id", "name", "updated_at" ], "type": "string", "default": "id", "title": "Sort" } }, { "name": "order", "in": "query", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string", "default": "asc", "title": "Order" } }, { "name": "ownership", "in": "query", "required": false, "schema": { "enum": [ "all", "net_new", "saved" ], "type": "string", "default": "all", "title": "Ownership" } }, { "name": "list_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[a-f0-9]{32}$" }, { "type": "null" } ], "title": "List Id" } }, { "name": "data_access", "in": "query", "required": false, "schema": { "anyOf": [ { "const": "licensed", "type": "string" }, { "type": "null" } ], "description": "Only records with a selected licensed snapshot in this workspace; email availability is irrelevant.", "title": "Data Access" }, "description": "Only records with a selected licensed snapshot in this workspace; email availability is irrelevant." }, { "name": "source_freshness", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "current", "update_available", "unavailable" ], "type": "string" }, { "type": "null" } ], "title": "Source Freshness" } }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200, "description": "Literal Unicode-folded substring over permitted saved or selected owned fields. Examines at most 1000 indexed candidates; follow next_cursor even on empty pages.", "default": "", "title": "Q" }, "description": "Literal Unicode-folded substring over permitted saved or selected owned fields. Examines at most 1000 indexed candidates; follow next_cursor even on empty pages." }, { "name": "view", "in": "query", "required": false, "schema": { "enum": [ "saved", "contacts" ], "type": "string", "default": "saved", "title": "View" } }, { "name": "company_record_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[a-f0-9]{32}$" }, { "type": "null" } ], "title": "Company Record Id" } }, { "name": "JOB_TITLE", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ], "title": "Job Title" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_PersonView_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:read" ] }, "post": { "summary": "Create Person", "operationId": "create_person_v1_contacts_post", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9_-]+$", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonFields" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Operation" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:write" ] } }, "/v1/contacts/from-search": { "post": { "summary": "Save Person", "operationId": "save_person_v1_contacts_from_search_post", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9_-]+$", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavePersonSource" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Operation" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:write" ] } }, "/v1/contacts/lookup": { "post": { "summary": "Lookup People", "operationId": "lookup_people_v1_contacts_lookup_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordLookup" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LookupResult_PersonView_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:read" ] } }, "/v1/contacts/{identity}": { "get": { "summary": "Person", "operationId": "person_v1_contacts__identity__get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[^\\x00-\\x1f\\x7f]+$", "title": "Identity" } }, { "name": "id_type", "in": "query", "required": false, "schema": { "enum": [ "source", "record" ], "type": "string", "default": "record", "title": "Id Type" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:read" ] }, "patch": { "summary": "Edit Person", "operationId": "edit_person_v1_contacts__identity__patch", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9_-]+$", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonEdit" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Operation" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:write" ] } }, "/v1/contacts/{identity}/campaigns": { "get": { "summary": "Contact Campaigns", "operationId": "contact_campaigns_v1_contacts__identity__campaigns_get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 2048, "default": "", "title": "Cursor" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 50, "minimum": 1, "description": "At most 50 campaigns with up to 50 connected List memberships each.", "default": 50, "title": "Limit" }, "description": "At most 50 campaigns with up to 50 connected List memberships each." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ContactCampaign_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:read", "campaigns:read" ] } }, "/v1/contacts/{identity}/preview-refreshes": { "post": { "summary": "Refresh Person", "operationId": "refresh_person_v1_contacts__identity__preview_refreshes_post", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9_-]+$", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreviewRefresh" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Operation" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:write" ] } }, "/v1/contacts/{identity}/source-checks": { "get": { "summary": "Person History", "operationId": "person_history_v1_contacts__identity__source_checks_get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 9007199254740991, "minimum": 0, "default": 0, "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": { "$ref": "#/components/schemas/SourceCheckHistory" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:read" ] }, "post": { "summary": "Check Person", "operationId": "check_person_v1_contacts__identity__source_checks_post", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9_-]+$", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceCheck" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Operation" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:write" ] } }, "/v1/data-capabilities": { "get": { "summary": "Capabilities", "operationId": "capabilities_v1_data_capabilities_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataCapabilities" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:read" ] } }, "/v1/data-job-capabilities": { "get": { "summary": "Capabilities", "operationId": "capabilities_v1_data_job_capabilities_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobCapabilities" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [], "x-resource-scopes": { "contacts": "contacts:read", "suppressions": "suppressions:read" } } }, "/v1/data-jobs": { "get": { "summary": "History", "operationId": "history_v1_data_jobs_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": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "sort", "in": "query", "required": false, "schema": { "enum": [ "created_at", "state", "amount_minor" ], "type": "string", "default": "created_at", "title": "Sort" } }, { "name": "order", "in": "query", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string", "default": "desc", "title": "Order" } }, { "name": "category", "in": "query", "required": false, "schema": { "enum": [ "contacts", "suppressions" ], "type": "string", "default": "contacts", "title": "Category" } }, { "name": "import_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[a-f0-9]{32}$" }, { "type": "null" } ], "title": "Import Id" } }, { "name": "campaign_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ], "title": "Campaign Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_JobView_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [], "x-resource-scopes": { "contacts": "contacts:read", "suppressions": "suppressions:read" } }, "post": { "summary": "Create", "operationId": "create_v1_data_jobs_post", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9_-]+$", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobRequest" } } } }, "responses": { "200": { "description": "Original job is no longer queued or awaiting action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobView" } } }, "headers": { "Location": { "description": "Relative URI of the original data job.", "schema": { "type": "string" } } } }, "202": { "description": "Original job is queued or awaiting action. Read it for progress.", "headers": { "Location": { "description": "Relative URI of the original data job.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobView" }, "examples": { "queued_original": { "summary": "Synthetic accepted original with Location /v1/data-jobs/11111111111111111111111111111111. Recover by the same Idempotency-Key through /v1/data-jobs/by-key; read progress rather than submit another job. Staging and submission do not purchase or send.", "value": { "id": "11111111111111111111111111111111", "parameters": { "kind": "import_records", "import_id": "22222222222222222222222222222222", "expected_digest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "max_records": 1 }, "entity_type": "person", "state": "queued", "revision": 1, "counts": { "processed": 0, "created": 0, "added": 0, "removed": 0, "unchanged": 0, "invalid": 0, "newly_granted": 0, "already_owned": 0, "excluded": 0, "checked": 0, "changed": 0, "missing": 0 }, "total_rows": 1, "target_revision": null, "reason": null, "created_at": "2026-10-12T00:00:00Z", "updated_at": "2026-10-12T00:00:00Z", "expires_at": "2026-10-19T00:00:00Z", "completed_at": null, "policy": null, "amount_minor": 0, "funding_required_minor": 0, "pending_order_id": null } } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-conditional-scopes": { "scope": [ "contacts:read" ], "scope.resource=people|companies": [ "search:read" ], "kind=unlock|refresh": [ "search:read", "data:purchase", "spending:write" ], "kind=export": [ "contacts:read" ], "kind=export_suppressions": [ "suppressions:read" ], "kind=export_campaign": [ "contacts:read", "campaigns:read" ], "kind=export,input.kind=identifiers": [ "search:read" ], "kind=export,export.version_mode!=owned_only": [ "search:read", "data:purchase", "spending:write" ], "kind=campaign_admission": [ "campaigns:write", "contacts:read", "audiences:write", "spending:write" ] }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [], "x-resource-scopes": { "contacts": "contacts:write", "suppressions": "suppressions:write", "export": "contacts:read", "export_suppressions": "suppressions:read", "export_campaign": [ "contacts:read", "campaigns:read" ] } } }, "/v1/data-jobs/by-key": { "get": { "summary": "By Key", "operationId": "by_key_v1_data_jobs_by_key_get", "parameters": [ { "name": "key", "in": "query", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "title": "Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [], "x-resource-scopes": { "contacts": "contacts:read", "suppressions": "suppressions:read" } } }, "/v1/data-jobs/{identity}": { "get": { "summary": "Original", "operationId": "original_v1_data_jobs__identity__get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [], "x-resource-scopes": { "contacts": "contacts:read", "suppressions": "suppressions:read" } } }, "/v1/data-jobs/{identity}/artifact": { "get": { "summary": "Artifact", "operationId": "artifact_v1_data_jobs__identity__artifact_get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobArtifact" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [], "x-resource-scopes": { "contacts": "contacts:read", "suppressions": "suppressions:read" } } }, "/v1/data-jobs/{identity}/cancel": { "post": { "summary": "Cancel", "operationId": "cancel_v1_data_jobs__identity__cancel_post", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-conditional-scopes": { "job.scope": [ "contacts:read" ], "job.scope.resource=people|companies": [ "search:read" ], "job.kind=unlock|refresh": [ "search:read", "data:purchase", "spending:write" ], "job.kind=export": [ "contacts:read" ], "job.kind=export_suppressions": [ "suppressions:read" ], "job.kind=export_campaign": [ "contacts:read", "campaigns:read" ], "job.kind=export,input.kind=identifiers": [ "search:read" ], "job.kind=export,job.export.version_mode!=owned_only": [ "search:read", "data:purchase", "spending:write" ], "job.kind=campaign_admission": [ "campaigns:write", "contacts:read", "audiences:write", "spending:write" ], "job.kind=source_check": [ "search:read" ], "job.kind=export_review|review_delivery": [ "contacts:read" ], "job.kind=review_delivery,billable_units>0": [ "data:purchase", "spending:write" ], "job.kind=review_delivery,billable_source_records": [ "search:read" ] }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [], "x-resource-scopes": { "contacts": "contacts:write", "suppressions": "suppressions:write", "export": "contacts:read", "export_suppressions": "suppressions:read", "export_campaign": [ "contacts:read", "campaigns:read" ] } } }, "/v1/data-jobs/{identity}/confirm": { "post": { "summary": "Confirm", "operationId": "confirm_v1_data_jobs__identity__confirm_post", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9_-]+$", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobConfirm" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Operation" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-conditional-scopes": { "job.scope": [ "contacts:read" ], "job.scope.resource=people|companies": [ "search:read" ], "job.purchase": [ "search:read", "data:purchase", "spending:write" ], "destination!=null": [ "contacts:write" ], "job.kind=export": [ "contacts:read" ] }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [], "x-resource-scopes": { "contacts": "contacts:write", "suppressions": "suppressions:write", "export": "contacts:read", "export_suppressions": "suppressions:read", "export_campaign": [ "contacts:read", "campaigns:read" ] } } }, "/v1/data-jobs/{identity}/delivery": { "get": { "summary": "Delivery", "operationId": "delivery_v1_data_jobs__identity__delivery_get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 5000000, "minimum": 0, "default": 0, "title": "After" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 50, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewDeliveryPage" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:read" ] } }, "/v1/data-jobs/{identity}/download": { "get": { "summary": "Download", "operationId": "download_v1_data_jobs__identity__download_get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } }, { "name": "session_binding", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[a-f0-9]{64}$" }, { "type": "null" } ], "title": "Session Binding" } }, { "name": "sha256", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[a-f0-9]{64}$" }, { "type": "null" } ], "title": "Sha256" } } ], "responses": { "200": { "description": "Successful Response", "content": { "text/csv": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "string", "format": "binary" } }, "application/x-ndjson": { "schema": { "type": "string", "format": "binary" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "type": "string", "format": "binary" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [], "x-resource-scopes": { "contacts": "contacts:read", "suppressions": "suppressions:read" } }, "head": { "summary": "Download", "operationId": "download_v1_data_jobs__identity__download_head", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } }, { "name": "session_binding", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[a-f0-9]{64}$" }, { "type": "null" } ], "title": "Session Binding" } }, { "name": "sha256", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[a-f0-9]{64}$" }, { "type": "null" } ], "title": "Sha256" } } ], "responses": { "200": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [], "x-resource-scopes": { "contacts": "contacts:read", "suppressions": "suppressions:read" } } }, "/v1/data-jobs/{identity}/results": { "get": { "summary": "Results", "operationId": "results_v1_data_jobs__identity__results_get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 5000000, "minimum": 0, "default": 0, "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": { "$ref": "#/components/schemas/JobResults" }, "examples": { "suppression_prefix": { "summary": "Synthetic committed suppression prefix. Recover each immutable receipt through /suppressions/operations/{suppression_operation_id}; duplicates cost zero and do not repeat audience cancellation. Job state owns remaining progress.", "value": { "items": [ { "ordinal": 1, "key": "customer-one", "record_id": null, "outcome": "added", "reason": null, "suppression_operation_id": "import-11111111111111111111111111111111-1", "amount_minor": 0 }, { "ordinal": 2, "key": "duplicate", "record_id": null, "outcome": "unchanged", "reason": null, "suppression_operation_id": "import-11111111111111111111111111111111-2", "amount_minor": 0 }, { "ordinal": 3, "key": "bad-target", "record_id": null, "outcome": "invalid", "reason": "invalid_suppressions", "suppression_operation_id": null, "amount_minor": 0 } ], "next_after": null } } } } } }, "410": { "description": "Per-row results expired; job totals and original purchase receipts remain available." }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [], "x-resource-scopes": { "contacts": "contacts:read", "suppressions": "suppressions:read" } } }, "/v1/data-jobs/{identity}/resume": { "post": { "summary": "Resume", "operationId": "resume_v1_data_jobs__identity__resume_post", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9_-]+$", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobResume" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Operation" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-conditional-scopes": { "job.scope": [ "contacts:read" ], "job.scope.resource=people|companies": [ "search:read" ], "job.kind=unlock|refresh": [ "search:read", "data:purchase", "spending:write" ], "job.kind=export": [ "contacts:read" ], "job.kind=export_suppressions": [ "suppressions:read" ], "job.kind=export_campaign": [ "contacts:read", "campaigns:read" ], "job.kind=export,input.kind=identifiers": [ "search:read" ], "job.kind=export,job.export.version_mode!=owned_only": [ "search:read", "data:purchase", "spending:write" ], "job.kind=campaign_admission": [ "campaigns:write", "contacts:read", "audiences:write", "spending:write" ], "job.kind=source_check": [ "search:read" ], "job.kind=review_delivery": [ "contacts:read" ], "job.kind=review_delivery,billable_units>0": [ "data:purchase", "spending:write" ], "job.kind=review_delivery,billable_source_records": [ "search:read" ] }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [], "x-resource-scopes": { "contacts": "contacts:write", "suppressions": "suppressions:write", "export": "contacts:read", "export_suppressions": "suppressions:read", "export_campaign": [ "contacts:read", "campaigns:read" ] } } }, "/v1/data-orders": { "get": { "summary": "History", "operationId": "history_v1_data_orders_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": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "sort", "in": "query", "required": false, "schema": { "enum": [ "created_at", "state", "amount_minor" ], "type": "string", "default": "created_at", "title": "Sort" } }, { "name": "order", "in": "query", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string", "default": "desc", "title": "Order" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_OrderSummary_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:read" ] }, "post": { "summary": "Purchase", "description": "SourceUnlock accepts a source ID without a saved record or review. It additionally requires search:read and contacts:write. Its Idempotency-Key is optional; owned reuse is free and never refreshes. IdentifierUnlock accepts up to100 keyed exact identifiers in one request, requires the same scopes and Idempotency-Key, and also reuses selected ownership without refreshing. RecordRefresh explicitly updates an owned contact/account with its expected revision and requires the same scopes plus Idempotency-Key. Equivalent licensed content is free.", "operationId": "purchase_v1_data_orders_post", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9_-]+$" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SourceUnlock" }, { "$ref": "#/components/schemas/IdentifierUnlock" }, { "$ref": "#/components/schemas/RecordRefresh" } ], "title": "Body" } } } }, "responses": { "200": { "description": "Original order no longer awaiting funds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderView" } } }, "headers": { "Location": { "description": "Relative URI of the original data order.", "schema": { "type": "string" } } } }, "202": { "description": "Original order awaits data funds and deliberate continuation. Reading it does not resume it.", "headers": { "Location": { "description": "Relative URI of the original data order.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderView" }, "examples": { "awaiting_funds": { "summary": "Synthetic original awaiting data funds; GET does not resume it. Prices are examples, not client constants.", "value": { "id": "order-example", "state": "awaiting_funds", "policy": { "id": "fixture-person", "entity_type": "person", "currency": "usd", "unit_amount_minor": 2 }, "currency": "usd", "max_amount_minor": 100, "amount_minor": 0, "funding_required_minor": 2, "items": [], "matches": null, "created_at": "2026-10-11T00:00:00.000000Z", "completed_at": null, "automatic_funding": true, "funding_error": "" } }, "matched_person_awaiting_funds": { "summary": "Synthetic matched person awaiting data funds; no licensed fields disclosed and no automatic continuation.", "value": { "id": "order-example", "state": "awaiting_funds", "policy": { "id": "fixture-person", "entity_type": "person", "currency": "usd", "unit_amount_minor": 2 }, "currency": "usd", "max_amount_minor": 100, "amount_minor": 0, "funding_required_minor": 2, "items": [], "matches": null, "created_at": "2026-10-11T00:00:00.000000Z", "completed_at": null, "automatic_funding": true, "funding_error": "" } }, "matched_company_awaiting_funds": { "summary": "Synthetic matched company awaiting data funds; fixture price is illustrative, not a server constant.", "value": { "id": "order-example", "state": "awaiting_funds", "policy": { "id": "fixture-company", "entity_type": "company", "currency": "usd", "unit_amount_minor": 1 }, "currency": "usd", "max_amount_minor": 100, "amount_minor": 0, "funding_required_minor": 1, "items": [], "matches": null, "created_at": "2026-10-11T00:00:00.000000Z", "completed_at": null, "automatic_funding": true, "funding_error": "" } } } } } }, "429": { "description": "New unfunded purchase exceeds pending-order capacity. No new order or debit is committed; fund, resume or cancel original purchases before retrying. Funded work and original recovery remain available.", "headers": { "Retry-After": { "description": "Seconds before retrying admission.", "schema": { "type": "integer" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "data:purchase", "spending:write" ] } }, "/v1/data-orders/by-key": { "get": { "summary": "By Key", "operationId": "by_key_v1_data_orders_by_key_get", "parameters": [ { "name": "key", "in": "query", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "title": "Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OrderView" }, { "$ref": "#/components/schemas/ReviewDelivery" }, { "$ref": "#/components/schemas/ReviewPurchase" } ], "title": "Response By Key V1 Data Orders By Key Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:read" ] } }, "/v1/data-orders/reviews/by-key": { "get": { "summary": "By Key", "operationId": "by_key_v1_data_orders_reviews_by_key_get", "parameters": [ { "name": "key", "in": "query", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "title": "Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ReviewView" }, { "$ref": "#/components/schemas/PreparingReview" } ], "title": "Response By Key V1 Data Orders Reviews By Key Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:read" ] } }, "/v1/data-orders/reviews/{identity}": { "get": { "summary": "Original", "operationId": "original_v1_data_orders_reviews__identity__get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ReviewView" }, { "$ref": "#/components/schemas/PreparingReview" } ], "title": "Response Original V1 Data Orders Reviews Identity Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:read" ] } }, "/v1/data-orders/reviews/{identity}/cancel": { "post": { "summary": "Cancel", "operationId": "cancel_v1_data_orders_reviews__identity__cancel_post", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ReviewView" }, { "$ref": "#/components/schemas/PreparingReview" } ], "title": "Response Cancel V1 Data Orders Reviews Identity Cancel Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:read" ] } }, "/v1/data-orders/reviews/{identity}/confirm": { "post": { "summary": "Confirm", "operationId": "confirm_v1_data_orders_reviews__identity__confirm_post", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9_-]+$", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewConfirm" } } } }, "responses": { "200": { "description": "Original order or job result.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ReviewDelivery" }, { "$ref": "#/components/schemas/ReviewPurchase" }, { "$ref": "#/components/schemas/JobView" } ], "title": "Response Confirm V1 Data Orders Reviews Identity Confirm Post" } } }, "headers": { "Location": { "description": "Relative URI of the original data order or data job, according to delivery mode.", "schema": { "type": "string" } } } }, "202": { "description": "Original awaits funds, queued work or explicit action.", "headers": { "Location": { "description": "Relative URI of the original data order or data job, according to delivery mode.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ReviewPurchase" }, { "$ref": "#/components/schemas/JobView" } ], "title": "Response 202 Confirm V1 Data Orders Reviews Identity Confirm Post" } } } }, "429": { "description": "New unfunded purchase exceeds pending-order capacity; no new purchase is committed. Existing purchase recovery remains available.", "headers": { "Retry-After": { "description": "Seconds before retrying admission.", "schema": { "type": "integer" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:read" ] } }, "/v1/data-orders/{identity}": { "get": { "summary": "Original", "operationId": "original_v1_data_orders__identity__get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OrderView" }, { "$ref": "#/components/schemas/ReviewDelivery" }, { "$ref": "#/components/schemas/ReviewPurchase" } ], "title": "Response Original V1 Data Orders Identity Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:read" ] } }, "/v1/data-orders/{identity}/cancel": { "post": { "summary": "Cancel", "operationId": "cancel_v1_data_orders__identity__cancel_post", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OrderView" }, { "$ref": "#/components/schemas/ReviewDelivery" }, { "$ref": "#/components/schemas/ReviewPurchase" } ], "title": "Response Cancel V1 Data Orders Identity Cancel Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "data:purchase", "spending:write" ] } }, "/v1/data-orders/{identity}/download": { "get": { "summary": "Download", "operationId": "download_v1_data_orders__identity__download_get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "text/csv": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "string", "format": "binary" } }, "application/x-ndjson": { "schema": { "type": "string", "format": "binary" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "type": "string", "format": "binary" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:read" ] } }, "/v1/data-orders/{identity}/resume": { "post": { "summary": "Resume", "description": "Deliberately settle the original authorized purchase using its frozen inputs, policy and spending ceiling. No request body or new purchase key is needed; repeating a terminal order returns its original receipt. Does not fetch source data or charge a payment card. Source unlock, refresh and enrichment originals additionally require search:read and contacts:write; review originals require contacts:read. Job-owned orders must resume through their revision-checked job instead.", "operationId": "resume_v1_data_orders__identity__resume_post", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } } ], "responses": { "200": { "description": "Original order no longer awaiting funds.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OrderView" }, { "$ref": "#/components/schemas/ReviewDelivery" }, { "$ref": "#/components/schemas/ReviewPurchase" } ], "title": "Response Resume V1 Data Orders Identity Resume Post" } } }, "headers": { "Location": { "description": "Relative URI of the original data order.", "schema": { "type": "string" } } } }, "202": { "description": "Original order awaits data funds and deliberate continuation. Reading it does not resume it.", "headers": { "Location": { "description": "Relative URI of the original data order.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OrderView" }, { "$ref": "#/components/schemas/ReviewPurchase" } ], "title": "Response 202 Resume V1 Data Orders Identity Resume Post" } } } }, "429": { "description": "New unfunded purchase exceeds pending-order capacity. No new order or debit is committed; fund, resume or cancel original purchases before retrying. Funded work and original recovery remain available.", "headers": { "Retry-After": { "description": "Seconds before retrying admission.", "schema": { "type": "integer" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "data:purchase", "spending:write" ] } }, "/v1/import-capabilities": { "get": { "summary": "Capabilities", "operationId": "capabilities_v1_import_capabilities_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportCapabilities" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [], "x-resource-scopes": { "contacts": "contacts:read", "suppressions": "suppressions:read" } } }, "/v1/imports": { "get": { "summary": "History", "operationId": "history_v1_imports_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": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "sort", "in": "query", "required": false, "schema": { "enum": [ "created_at", "state" ], "type": "string", "default": "created_at", "title": "Sort" } }, { "name": "order", "in": "query", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string", "default": "desc", "title": "Order" } }, { "name": "category", "in": "query", "required": false, "schema": { "enum": [ "contacts", "suppressions" ], "type": "string", "default": "contacts", "title": "Category" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ImportView_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [], "x-resource-scopes": { "contacts": "contacts:read", "suppressions": "suppressions:read" } }, "post": { "summary": "Create", "operationId": "create_v1_imports_post", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9_-]+$", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportCreate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [], "x-resource-scopes": { "contacts": "contacts:write", "suppressions": "suppressions:write" } } }, "/v1/imports/by-key": { "get": { "summary": "By Key", "operationId": "by_key_v1_imports_by_key_get", "parameters": [ { "name": "key", "in": "query", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "title": "Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [], "x-resource-scopes": { "contacts": "contacts:read", "suppressions": "suppressions:read" } } }, "/v1/imports/{identity}": { "get": { "summary": "Original", "operationId": "original_v1_imports__identity__get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [], "x-resource-scopes": { "contacts": "contacts:read", "suppressions": "suppressions:read" } } }, "/v1/imports/{identity}/cancel": { "post": { "summary": "Cancel", "operationId": "cancel_v1_imports__identity__cancel_post", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [], "x-resource-scopes": { "contacts": "contacts:write", "suppressions": "suppressions:write" } } }, "/v1/imports/{identity}/chunks/{position}": { "get": { "summary": "Chunk", "operationId": "chunk_v1_imports__identity__chunks__position__get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } }, { "name": "position", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 0, "exclusiveMaximum": 50000, "title": "Position" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChunkView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [], "x-resource-scopes": { "contacts": "contacts:read", "suppressions": "suppressions:read" } }, "put": { "summary": "Upload", "operationId": "upload_v1_imports__identity__chunks__position__put", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } }, { "name": "position", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 0, "exclusiveMaximum": 50000, "title": "Position" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChunkView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "requestBody": { "required": true, "content": { "text/csv": { "schema": { "type": "string", "format": "binary", "maxLength": 1048576 } }, "application/x-ndjson": { "schema": { "type": "string", "format": "binary", "maxLength": 1048576 } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [], "x-resource-scopes": { "contacts": "contacts:write", "suppressions": "suppressions:write" } } }, "/v1/imports/{identity}/rows": { "get": { "summary": "Rows", "operationId": "rows_v1_imports__identity__rows_get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 5000000, "minimum": 0, "default": 0, "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": { "$ref": "#/components/schemas/ImportRows" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [], "x-resource-scopes": { "contacts": "contacts:read", "suppressions": "suppressions:read" } } }, "/v1/imports/{identity}/seal": { "post": { "summary": "Seal", "operationId": "seal_v1_imports__identity__seal_post", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportSeal" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [], "x-resource-scopes": { "contacts": "contacts:write", "suppressions": "suppressions:write" } } }, "/v1/lists": { "get": { "summary": "Lists", "operationId": "lists_v1_lists_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": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "state", "in": "query", "required": false, "schema": { "enum": [ "active", "archived", "all" ], "type": "string", "default": "active", "title": "State" } }, { "name": "name_prefix", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200, "default": "", "title": "Name Prefix" } }, { "name": "sort", "in": "query", "required": false, "schema": { "enum": [ "id", "name", "updated_at" ], "type": "string", "default": "id", "title": "Sort" } }, { "name": "order", "in": "query", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string", "default": "asc", "title": "Order" } }, { "name": "entity_type", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "person", "company" ], "type": "string" }, { "type": "null" } ], "title": "Entity Type" } }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200, "description": "Literal Unicode-folded substring of the List name. Examines at most 1000 indexed candidates; follow next_cursor even on empty pages.", "default": "", "title": "Q" }, "description": "Literal Unicode-folded substring of the List name. Examines at most 1000 indexed candidates; follow next_cursor even on empty pages." }, { "name": "record_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[a-f0-9]{32}$" }, { "type": "null" } ], "description": "Lists containing this workspace record; requires entity_type and ID sort. Sparse state filters may return an empty page with a cursor.", "title": "Record Id" }, "description": "Lists containing this workspace record; requires entity_type and ID sort. Sparse state filters may return an empty page with a cursor." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ListView_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:read" ] }, "post": { "summary": "Create List", "operationId": "create_list_v1_lists_post", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9_-]+$", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCreate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Operation" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:write" ] } }, "/v1/lists/{identity}": { "get": { "summary": "Listing", "operationId": "listing_v1_lists__identity__get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:read" ] }, "patch": { "summary": "Edit List", "operationId": "edit_list_v1_lists__identity__patch", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9_-]+$", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEdit" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Operation" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:write" ] } }, "/v1/lists/{identity}/campaigns": { "get": { "summary": "Listing Campaigns", "operationId": "listing_campaigns_v1_lists__identity__campaigns_get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 2048, "default": "", "title": "Cursor" } }, { "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": { "$ref": "#/components/schemas/Page_ListCampaign_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:read", "campaigns:read" ] } }, "/v1/lists/{identity}/members": { "get": { "summary": "Members", "operationId": "members_v1_lists__identity__members_get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 2048, "default": "", "title": "Cursor" } }, { "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": { "$ref": "#/components/schemas/Page_Union_PersonView__CompanyView__" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:read" ] } }, "/v1/lists/{identity}/membership-changes": { "post": { "summary": "Change Members", "operationId": "change_members_v1_lists__identity__membership_changes_post", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9_-]+$", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipChange" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Operation" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:write" ] } }, "/v1/lists/{identity}/source-check-policy": { "get": { "summary": "Status", "operationId": "status_v1_lists__identity__source_check_policy_get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckPolicyView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:read" ] }, "patch": { "summary": "Update", "operationId": "update_v1_lists__identity__source_check_policy_patch", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9_-]+$", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckPolicyDisable" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckPolicyView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:write" ] } }, "/v1/lists/{identity}/source-check-rounds": { "get": { "summary": "History", "operationId": "history_v1_lists__identity__source_check_rounds_get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 2048, "default": "", "title": "Cursor" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 50, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_CheckRoundView_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:read" ] } }, "/v1/operations/by-key": { "get": { "summary": "Operation By Key", "operationId": "operation_by_key_v1_operations_by_key_get", "parameters": [ { "name": "kind", "in": "query", "required": true, "schema": { "enum": [ "people.create", "people.edit", "companies.create", "companies.edit", "lists.create", "lists.edit", "lists.membership", "people.save_source", "companies.save_source", "people.check_source", "companies.check_source", "people.refresh_preview", "companies.refresh_preview", "searches.create", "searches.edit", "search_sets.create", "search_sets.edit", "data_jobs.resume", "data_jobs.confirm" ], "type": "string", "title": "Kind" } }, { "name": "key", "in": "query", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "title": "Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Operation" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [], "x-resource-scopes": { "contacts": "contacts:read", "suppressions": "suppressions:read" } } }, "/v1/operations/{identity}": { "get": { "summary": "Operation", "operationId": "operation_v1_operations__identity__get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Operation" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [], "x-resource-scopes": { "contacts": "contacts:read", "suppressions": "suppressions:read" } } }, "/v1/people/lookup": { "post": { "summary": "Lookup People", "operationId": "lookup_people_v1_people_lookup_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceLookup" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LookupResult_PersonPreview_" } } } }, "429": { "description": "Workspace discovery or request capacity exhausted; preserve the query and offer explicit retry.", "headers": { "Retry-After": { "description": "Seconds until retry may be attempted.", "schema": { "type": "integer", "minimum": 1.0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchRateLimit" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "search:read" ] } }, "/v1/people/resolve": { "post": { "summary": "Resolve People", "operationId": "resolve_people_v1_people_resolve_post", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9_-]+$" }, { "type": "null" } ], "description": "Required for multiple inputs; preserves the frozen result across retries.", "title": "Idempotency-Key" }, "description": "Required for multiple inputs; preserves the frozen result across retries." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolveRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolvePage" } } } }, "429": { "description": "Workspace discovery or request capacity exhausted; preserve the query and offer explicit retry.", "headers": { "Retry-After": { "description": "Seconds until retry may be attempted.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchRateLimit" } } } }, "202": { "description": "Matching continues on the same result set. Repeat the same body and Idempotency-Key to read progress without starting another lookup.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolvePage" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "search:read" ] } }, "/v1/people/{identity}": { "get": { "summary": "Person", "operationId": "person_v1_people__identity__get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[^\\x00-\\x1f\\x7f]+$", "title": "Identity" } }, { "name": "id_type", "in": "query", "required": false, "schema": { "enum": [ "source", "record" ], "type": "string", "default": "source", "title": "Id Type" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonPreview" } } } }, "429": { "description": "Workspace discovery or request capacity exhausted; preserve the query and offer explicit retry.", "headers": { "Retry-After": { "description": "Seconds until retry may be attempted.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchRateLimit" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "search:read" ] } }, "/v1/saved-searches": { "get": { "summary": "Searches", "operationId": "searches_v1_saved_searches_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": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "state", "in": "query", "required": false, "schema": { "enum": [ "active", "archived" ], "type": "string", "default": "active", "title": "State" } }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200, "description": "Literal NFKC/casefolded, whitespace-normalized name substring. At most 1000 indexed candidates per page; follow next_cursor even on empty pages. Live ID traversal, not frozen membership.", "default": "", "title": "Q" }, "description": "Literal NFKC/casefolded, whitespace-normalized name substring. At most 1000 indexed candidates per page; follow next_cursor even on empty pages. Live ID traversal, not frozen membership." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_SavedSearchView_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "search:read" ] }, "post": { "summary": "Create", "operationId": "create_v1_saved_searches_post", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9_-]+$", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedSearchCreate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Operation" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:write", "search:read" ] } }, "/v1/saved-searches/{identity}": { "get": { "summary": "Search", "operationId": "search_v1_saved_searches__identity__get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedSearchView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "search:read" ] }, "patch": { "summary": "Edit", "operationId": "edit_v1_saved_searches__identity__patch", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9_-]+$", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedSearchEdit" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Operation" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:write", "search:read" ] } }, "/v1/schema": { "get": { "summary": "Schema", "operationId": "schema_v1_schema_get", "parameters": [ { "name": "data_source", "in": "query", "required": false, "schema": { "enum": [ "people", "companies" ], "type": "string", "default": "people", "title": "Data Source" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogueSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "search:read" ] } }, "/v1/search": { "post": { "summary": "Search", "operationId": "search_v1_search_post", "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SearchQuery-Input" }, { "$ref": "#/components/schemas/SearchNext" } ], "title": "Body" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchPage" } } } }, "429": { "description": "Workspace discovery or request capacity exhausted; preserve the query and offer explicit retry.", "headers": { "Retry-After": { "description": "Seconds until retry may be attempted.", "schema": { "type": "integer", "minimum": 1.0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchRateLimit" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "search:read" ] } }, "/v1/search-sets": { "get": { "summary": "Listing", "operationId": "listing_v1_search_sets_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": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "state", "in": "query", "required": false, "schema": { "enum": [ "active", "archived" ], "type": "string", "default": "active", "title": "State" } }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200, "description": "Literal NFKC/casefolded, whitespace-normalized name substring. At most 1000 indexed candidates per page; follow next_cursor even on empty pages. Live ID traversal, not frozen membership.", "default": "", "title": "Q" }, "description": "Literal NFKC/casefolded, whitespace-normalized name substring. At most 1000 indexed candidates per page; follow next_cursor even on empty pages. Live ID traversal, not frozen membership." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_DomainSetView_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "search:read" ] }, "post": { "summary": "Create", "operationId": "create_v1_search_sets_post", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9_-]+$", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainSetCreate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Operation" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:write", "search:read" ] } }, "/v1/search-sets/{identity}": { "get": { "summary": "Original", "operationId": "original_v1_search_sets__identity__get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainSetView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "search:read" ] }, "patch": { "summary": "Edit", "operationId": "edit_v1_search_sets__identity__patch", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9_-]+$", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainSetEdit" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Operation" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:write", "search:read" ] } }, "/v1/search/facets": { "post": { "summary": "Facets", "operationId": "facets_v1_search_facets_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacetRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacetPage" } } } }, "429": { "description": "Workspace discovery or request capacity exhausted; preserve the query and offer explicit retry.", "headers": { "Retry-After": { "description": "Seconds until retry may be attempted.", "schema": { "type": "integer", "minimum": 1.0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchRateLimit" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-conditional-scopes": { "query.ownership=saved|net_new": [ "contacts:read" ] }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "search:read" ] } }, "/v1/search/results/{identity}": { "delete": { "summary": "Close", "operationId": "close_v1_search_results__identity__delete", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "search:read" ] } }, "/v1/selections": { "get": { "summary": "History", "operationId": "history_v1_selections_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": 200, "minimum": 1, "default": 50, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_SelectionView_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:read" ] } }, "/v1/selections/by-key": { "get": { "summary": "By Key", "operationId": "by_key_v1_selections_by_key_get", "parameters": [ { "name": "key", "in": "query", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "title": "Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectionView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:read" ] } }, "/v1/selections/{identity}": { "get": { "summary": "Original", "operationId": "original_v1_selections__identity__get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectionView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:read" ] } }, "/v1/selections/{identity}/cancel": { "post": { "summary": "Cancel", "operationId": "cancel_v1_selections__identity__cancel_post", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectionView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:write" ] } }, "/v1/selections/{identity}/previews": { "get": { "summary": "Preview Page", "operationId": "preview_page_v1_selections__identity__previews_get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 2048, "default": "", "title": "Cursor" } }, { "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": { "$ref": "#/components/schemas/SelectionPreviewPage" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts:read" ] } }, "/v1/selections/{identity}/rows": { "get": { "summary": "Rows", "operationId": "rows_v1_selections__identity__rows_get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Identity" } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 5000000, "minimum": 0, "default": 0, "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": { "$ref": "#/components/schemas/ImportRows" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "contacts: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": { "$ref": "#/components/schemas/VerificationBatchView" } } } }, "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": { "$ref": "#/components/schemas/VerificationBatchView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "audiences:write" ] } }, "/workspace/sending-outlook": { "get": { "summary": "Read Sending Outlook", "operationId": "read_sending_outlook_workspace_sending_outlook_get", "parameters": [ { "name": "projection", "in": "query", "required": false, "schema": { "enum": [ "eligibility", "estimated" ], "type": "string", "default": "eligibility", "title": "Projection" } }, { "name": "timezone", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 128, "default": "", "title": "Timezone" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendingOutlook" } } } }, "409": { "description": "Invalid projection timezone or current projection conflict; inspect detail.code", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectionConflict" } } } }, "503": { "description": "Read capacity or storage temporarily unavailable; inspect detail.code and Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectionConflict" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "campaigns:read" ] } }, "/workspace/sending-policy": { "get": { "summary": "Read", "operationId": "read_workspace_sending_policy_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyStatus" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "usage:read" ] } }, "/workspace/sending-policy/operations/{identity}": { "get": { "summary": "Inspect", "operationId": "inspect_workspace_sending_policy_operations__identity__get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendingPolicyOperation" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "WorkspaceKey": [] } ], "x-required-scopes": [ "usage:read" ] } } }, "components": { "securitySchemes": { "WorkspaceKey": { "type": "http", "scheme": "bearer" } }, "schemas": { "AccountLimit": { "properties": { "daily_limit": { "type": "integer", "title": "Daily Limit" }, "revision": { "type": "integer", "title": "Revision" }, "day": { "type": "string", "title": "Day" }, "clock": { "type": "string", "const": "UTC", "title": "Clock" }, "committed": { "type": "integer", "title": "Committed" }, "remaining": { "type": "integer", "title": "Remaining" }, "semantics": { "type": "string", "const": "authorized_daily_capacity", "title": "Semantics" }, "capacity_operation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Capacity Operation" }, "capacity_valid_until": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Capacity Valid Until" }, "sending_pools": { "items": { "$ref": "#/components/schemas/SendingPoolCapacity" }, "type": "array", "maxItems": 3, "title": "Sending Pools" }, "active_campaigns": { "type": "integer", "title": "Active Campaigns" }, "requested_daily_sends": { "type": "integer", "title": "Requested Daily Sends" }, "configured_campaigns": { "type": "integer", "title": "Configured Campaigns" }, "configured_daily_sends": { "type": "integer", "title": "Configured Daily Sends" }, "allocation": { "anyOf": [ { "$ref": "#/components/schemas/AllocationState" }, { "type": "null" } ] }, "items": { "items": { "$ref": "#/components/schemas/AccountLimitCampaign" }, "type": "array", "maxItems": 25, "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "additionalProperties": false, "type": "object", "required": [ "daily_limit", "revision", "day", "clock", "committed", "remaining", "semantics", "sending_pools", "active_campaigns", "requested_daily_sends", "configured_campaigns", "configured_daily_sends", "allocation", "items", "next_cursor" ], "title": "AccountLimit" }, "AccountLimitCampaign": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "daily_limit": { "type": "integer", "title": "Daily Limit" }, "revision": { "type": "integer", "title": "Revision" }, "sending_pool": { "type": "string", "enum": [ "mailbox", "transactional", "all" ], "title": "Sending Pool", "default": "mailbox" } }, "additionalProperties": false, "type": "object", "required": [ "id", "name", "daily_limit", "revision" ], "title": "AccountLimitCampaign" }, "AdmissionConfirmIn": { "properties": { "review_id": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Review Id" } }, "additionalProperties": false, "type": "object", "required": [ "review_id" ], "title": "AdmissionConfirmIn" }, "AdmissionCounts": { "properties": { "examined": { "type": "integer", "minimum": 0.0, "title": "Examined", "default": 0 }, "added": { "type": "integer", "minimum": 0.0, "title": "Added", "default": 0 }, "held": { "type": "integer", "minimum": 0.0, "title": "Held", "default": 0 }, "already_admitted": { "type": "integer", "minimum": 0.0, "title": "Already Admitted", "default": 0 } }, "type": "object", "title": "AdmissionCounts" }, "AdmissionHistoryItem": { "properties": { "id": { "type": "string", "title": "Id" }, "campaign_id": { "type": "string", "title": "Campaign Id" }, "actor": { "type": "string", "title": "Actor" }, "created_at": { "type": "number", "title": "Created At" }, "state": { "type": "string", "const": "completed", "title": "State", "default": "completed" }, "added": { "type": "integer", "title": "Added" }, "held": { "type": "integer", "title": "Held" }, "already_admitted": { "type": "integer", "title": "Already Admitted" }, "campaign_revision": { "type": "integer", "title": "Campaign Revision" }, "audience_revision": { "type": "integer", "title": "Audience Revision" }, "refill_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Refill Id" }, "send_budget_added_cents": { "type": "integer", "title": "Send Budget Added Cents" }, "included": { "items": { "$ref": "#/components/schemas/IncludedAdmission" }, "type": "array", "title": "Included" }, "examined": { "type": "integer", "title": "Examined" }, "sources": { "items": { "$ref": "#/components/schemas/AdmissionSourceCounts" }, "type": "array", "title": "Sources" }, "held_reasons": { "additionalProperties": { "type": "integer" }, "type": "object", "title": "Held Reasons" } }, "type": "object", "required": [ "id", "campaign_id", "actor", "created_at", "added", "held", "already_admitted", "campaign_revision", "audience_revision", "refill_id", "send_budget_added_cents", "examined", "sources", "held_reasons" ], "title": "AdmissionHistoryItem" }, "AdmissionHistoryPage": { "properties": { "as_of": { "type": "number", "title": "As Of" }, "count_basis": { "type": "string", "const": "confirmed_review_occurrences_in_page", "title": "Count Basis", "default": "confirmed_review_occurrences_in_page" }, "items": { "items": { "$ref": "#/components/schemas/AdmissionHistoryItem" }, "type": "array", "title": "Items" }, "totals": { "$ref": "#/components/schemas/AdmissionCounts" }, "sources": { "items": { "$ref": "#/components/schemas/AdmissionSourceCounts" }, "type": "array", "title": "Sources" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "type": "object", "required": [ "as_of", "items", "totals", "sources", "next_cursor" ], "title": "AdmissionHistoryPage" }, "AdmissionItem": { "properties": { "person_id": { "type": "string", "title": "Person Id" }, "source_ids": { "items": { "type": "string" }, "type": "array", "title": "Source Ids" }, "outcome": { "type": "string", "enum": [ "eligible", "held", "already_admitted" ], "title": "Outcome" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" } }, "type": "object", "required": [ "person_id", "source_ids", "outcome" ], "title": "AdmissionItem" }, "AdmissionResult": { "properties": { "id": { "type": "string", "title": "Id" }, "campaign_id": { "type": "string", "title": "Campaign Id" }, "actor": { "type": "string", "title": "Actor" }, "created_at": { "type": "number", "title": "Created At" }, "state": { "type": "string", "const": "completed", "title": "State", "default": "completed" }, "added": { "type": "integer", "title": "Added" }, "held": { "type": "integer", "title": "Held" }, "already_admitted": { "type": "integer", "title": "Already Admitted" }, "campaign_revision": { "type": "integer", "title": "Campaign Revision" }, "audience_revision": { "type": "integer", "title": "Audience Revision" }, "refill_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Refill Id" }, "send_budget_added_cents": { "type": "integer", "title": "Send Budget Added Cents" }, "included": { "items": { "$ref": "#/components/schemas/IncludedAdmission" }, "type": "array", "title": "Included" } }, "type": "object", "required": [ "id", "campaign_id", "actor", "created_at", "added", "held", "already_admitted", "campaign_revision", "audience_revision", "refill_id", "send_budget_added_cents" ], "title": "AdmissionResult" }, "AdmissionReview": { "properties": { "id": { "type": "string", "title": "Id" }, "campaign_id": { "type": "string", "title": "Campaign Id" }, "campaign_revision": { "type": "integer", "title": "Campaign Revision" }, "audience_revision": { "type": "integer", "title": "Audience Revision" }, "sources_revision": { "type": "integer", "title": "Sources Revision" }, "state": { "type": "string", "const": "reviewed", "title": "State", "default": "reviewed" }, "items": { "items": { "$ref": "#/components/schemas/AdmissionItem" }, "type": "array", "title": "Items" }, "send_budget_added_cents": { "type": "integer", "title": "Send Budget Added Cents" }, "created_at": { "type": "number", "title": "Created At" }, "expires_at": { "type": "number", "title": "Expires At" } }, "type": "object", "required": [ "id", "campaign_id", "campaign_revision", "audience_revision", "sources_revision", "items", "send_budget_added_cents", "created_at", "expires_at" ], "title": "AdmissionReview" }, "AdmissionSourceCounts": { "properties": { "examined": { "type": "integer", "minimum": 0.0, "title": "Examined", "default": 0 }, "added": { "type": "integer", "minimum": 0.0, "title": "Added", "default": 0 }, "held": { "type": "integer", "minimum": 0.0, "title": "Held", "default": 0 }, "already_admitted": { "type": "integer", "minimum": 0.0, "title": "Already Admitted", "default": 0 }, "source_id": { "type": "string", "title": "Source Id" } }, "type": "object", "required": [ "source_id" ], "title": "AdmissionSourceCounts" }, "AgentClassificationObservation": { "properties": { "state": { "type": "string", "enum": [ "pending", "leased", "suggested", "applied", "failed", "unknown" ], "title": "State" }, "model": { "type": "string", "title": "Model" }, "policy_version": { "type": "string", "title": "Policy Version" }, "suggestion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Suggestion" }, "choice_confidence": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Choice Confidence" }, "explicit_opt_out": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Explicit Opt Out" }, "input_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Input Tokens" }, "output_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Output Tokens" }, "cost_usd_micros": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Cost Usd Micros" }, "provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider" }, "resolved_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resolved Model" }, "error": { "type": "string", "title": "Error" }, "updated_at": { "type": "number", "title": "Updated At" }, "origin": { "type": "string", "enum": [ "live", "backfill" ], "title": "Origin" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" }, "probabilities": { "anyOf": [ { "additionalProperties": { "type": "number", "maximum": 1.0, "minimum": 0.0 }, "type": "object" }, { "type": "null" } ], "title": "Probabilities", "description": "Historical provider probability keys follow the recorded policy version; native evidence may be null." }, "run_id": { "type": "string", "title": "Run Id" }, "evidence": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Evidence" }, "evidence_qualified": { "type": "boolean", "title": "Evidence Qualified" }, "explanation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Explanation" } }, "additionalProperties": false, "type": "object", "required": [ "state", "model", "policy_version", "suggestion", "choice_confidence", "explicit_opt_out", "input_tokens", "output_tokens", "cost_usd_micros", "provider", "resolved_model", "error", "updated_at", "origin", "reason", "probabilities", "run_id", "evidence", "evidence_qualified", "explanation" ], "title": "AgentClassificationObservation" }, "AllocationApply": { "properties": { "operation_id": { "type": "string", "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._~-]*$", "title": "Operation Id" }, "configuration": { "type": "string", "pattern": "^[a-f0-9]{64}$", "title": "Configuration" }, "changes": { "items": { "$ref": "#/components/schemas/AllocationChange" }, "type": "array", "maxItems": 100, "minItems": 1, "title": "Changes" } }, "additionalProperties": false, "type": "object", "required": [ "operation_id", "configuration", "changes" ], "title": "AllocationApply" }, "AllocationChange": { "properties": { "campaign": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Campaign" }, "expected_revision": { "type": "integer", "minimum": 1.0, "title": "Expected Revision" }, "daily_limit": { "type": "integer", "maximum": 15000.0, "minimum": 0.0, "title": "Daily Limit", "description": "Finite daily campaign outbound ceiling; zero is unallocated, not unlimited." } }, "additionalProperties": false, "type": "object", "required": [ "campaign", "expected_revision", "daily_limit" ], "title": "AllocationChange" }, "AllocationCoverage": { "properties": { "date": { "type": "string", "title": "Date" }, "ready": { "type": "integer", "minimum": 0.0, "title": "Ready" }, "preparing": { "type": "integer", "minimum": 0.0, "title": "Preparing" }, "shortfall": { "type": "integer", "minimum": 0.0, "title": "Shortfall" } }, "additionalProperties": false, "type": "object", "required": [ "date", "ready", "preparing", "shortfall" ], "title": "AllocationCoverage" }, "AllocationPreview": { "properties": { "state": { "type": "string", "enum": [ "improved", "no_improvement", "unavailable" ], "title": "State" }, "reason": { "type": "string", "title": "Reason" }, "configuration": { "type": "string", "title": "Configuration" }, "observed_at": { "type": "number", "title": "Observed At" }, "valid_until": { "type": "number", "title": "Valid Until" }, "changes": { "items": { "$ref": "#/components/schemas/AllocationChange" }, "type": "array", "title": "Changes" }, "before": { "items": { "$ref": "#/components/schemas/AllocationCoverage" }, "type": "array", "title": "Before" }, "after": { "items": { "$ref": "#/components/schemas/AllocationCoverage" }, "type": "array", "title": "After" } }, "additionalProperties": false, "type": "object", "required": [ "state", "reason", "configuration", "observed_at", "valid_until", "changes", "before", "after" ], "title": "AllocationPreview" }, "AllocationPreviewIn": { "properties": { "timezone": { "type": "string", "maxLength": 128, "title": "Timezone", "default": "UTC" }, "changes": { "items": { "$ref": "#/components/schemas/AllocationChange" }, "type": "array", "maxItems": 100, "title": "Changes" } }, "additionalProperties": false, "type": "object", "title": "AllocationPreviewIn" }, "AllocationReceipt": { "properties": { "id": { "type": "string", "title": "Id" }, "workspace": { "type": "string", "title": "Workspace" }, "actor": { "type": "string", "title": "Actor" }, "request_digest": { "type": "string", "title": "Request Digest" }, "recorded_at": { "type": "number", "title": "Recorded At" }, "changes": { "items": { "$ref": "#/components/schemas/AllocationRecordedChange" }, "type": "array", "title": "Changes" }, "outcome": { "type": "string", "enum": [ "recorded", "no_effect" ], "title": "Outcome" } }, "additionalProperties": false, "type": "object", "required": [ "id", "workspace", "actor", "request_digest", "recorded_at", "changes", "outcome" ], "title": "AllocationReceipt" }, "AllocationRecordedChange": { "properties": { "campaign": { "type": "string", "title": "Campaign" }, "before": { "type": "integer", "title": "Before" }, "after": { "type": "integer", "title": "After" }, "before_revision": { "type": "integer", "title": "Before Revision" }, "after_revision": { "type": "integer", "title": "After Revision" } }, "additionalProperties": false, "type": "object", "required": [ "campaign", "before", "after", "before_revision", "after_revision" ], "title": "AllocationRecordedChange" }, "AllocationResult": { "properties": { "operation": { "$ref": "#/components/schemas/AllocationReceipt" }, "allocation": { "anyOf": [ { "$ref": "#/components/schemas/AllocationState" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "required": [ "operation", "allocation" ], "title": "AllocationResult" }, "AllocationState": { "properties": { "configuration": { "type": "string", "title": "Configuration" }, "available": { "type": "integer", "minimum": 0.0, "title": "Available" }, "overage": { "type": "integer", "minimum": 0.0, "title": "Overage" }, "pools": { "anyOf": [ { "items": { "$ref": "#/components/schemas/SendingPoolAllocation" }, "type": "array", "maxItems": 3 }, { "type": "null" } ], "title": "Pools" } }, "additionalProperties": false, "type": "object", "required": [ "configuration", "available", "overage" ], "title": "AllocationState" }, "AppendCounts": { "properties": { "added": { "type": "integer", "title": "Added" }, "contacts": { "type": "integer", "title": "Contacts" }, "revision": { "type": "integer", "title": "Revision" } }, "additionalProperties": false, "type": "object", "required": [ "added", "contacts", "revision" ], "title": "AppendCounts" }, "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" }, "BillingHistoryEntry": { "properties": { "event_id": { "type": "string", "title": "Event Id" }, "kind": { "type": "string", "title": "Kind" }, "amount": { "type": "integer", "title": "Amount" }, "created_at": { "type": "number", "title": "Created At" }, "workspace": { "type": "string", "title": "Workspace" }, "service_interval": { "anyOf": [ { "$ref": "#/components/schemas/ServiceInterval" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "required": [ "event_id", "kind", "amount", "created_at", "workspace", "service_interval" ], "title": "BillingHistoryEntry" }, "BillingHistoryPage": { "properties": { "items": { "items": { "$ref": "#/components/schemas/BillingHistoryEntry" }, "type": "array", "maxItems": 200, "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "start": { "type": "number", "title": "Start" }, "end": { "type": "number", "title": "End" }, "currency": { "type": "string", "const": "USD", "title": "Currency" }, "amount_unit": { "type": "string", "const": "cents", "title": "Amount Unit" }, "observed_at": { "type": "number", "title": "Observed At" }, "semantics": { "type": "string", "const": "posted_wallet_events_not_pending_holds_or_delivery", "title": "Semantics" }, "order": { "type": "string", "const": "created_at_workspace_event_id_desc", "title": "Order" } }, "additionalProperties": false, "type": "object", "required": [ "items", "next_cursor", "start", "end", "currency", "amount_unit", "observed_at", "semantics", "order" ], "title": "BillingHistoryPage" }, "CalendarBuckets": { "properties": { "total": { "type": "integer", "minimum": 0.0, "title": "Total" }, "before_interval": { "type": "integer", "minimum": 0.0, "title": "Before Interval" }, "within_interval": { "type": "integer", "minimum": 0.0, "title": "Within Interval" }, "next_24h": { "type": "integer", "minimum": 0.0, "title": "Next 24H" }, "later": { "type": "integer", "minimum": 0.0, "title": "Later" } }, "additionalProperties": false, "type": "object", "required": [ "total", "before_interval", "within_interval", "next_24h", "later" ], "title": "CalendarBuckets" }, "CalendarDay": { "properties": { "date": { "type": "string", "title": "Date" }, "loaded": { "type": "integer", "minimum": 0.0, "title": "Loaded" }, "has_more": { "type": "boolean", "title": "Has More" }, "summary": { "$ref": "#/components/schemas/CalendarSummary" } }, "additionalProperties": false, "type": "object", "required": [ "date", "loaded", "has_more", "summary" ], "title": "CalendarDay" }, "CalendarDelivery": { "properties": { "accepted": { "type": "integer", "minimum": 0.0, "title": "Accepted" }, "failed": { "type": "integer", "minimum": 0.0, "title": "Failed" }, "delayed": { "type": "integer", "minimum": 0.0, "title": "Delayed" } }, "additionalProperties": false, "type": "object", "required": [ "accepted", "failed", "delayed" ], "title": "CalendarDelivery" }, "CalendarItem": { "properties": { "item_id": { "type": "string", "maxLength": 64, "minLength": 64, "pattern": "^[a-f0-9]{64}$", "title": "Item Id", "description": "Stable opaque identity of this native calendar item, including an individual delivery report. Not the accepted-send event, a cursor or send authority." }, "job": { "type": "string", "title": "Job" }, "event": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Event" }, "campaign": { "type": "string", "title": "Campaign" }, "workspace": { "type": "string", "title": "Workspace" }, "step": { "type": "integer", "minimum": 0.0, "title": "Step" }, "sequence_position": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sequence Position", "description": "Current one-based route position for mutable plans, retained attempt position for history; null when unknown." }, "sequence_total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sequence Total", "description": "Definition length at that position; historical totals can be unknown." }, "state": { "type": "string", "title": "State" }, "instant": { "type": "number", "title": "Instant" }, "recipient": { "type": "string", "title": "Recipient" }, "name": { "type": "string", "title": "Name" }, "campaign_state": { "type": "string", "title": "Campaign State" }, "workspace_state": { "type": "string", "title": "Workspace State" }, "kind": { "type": "string", "enum": [ "planned", "history", "bounce" ], "title": "Kind" }, "campaign_timezone": { "type": "string", "title": "Campaign Timezone" }, "utc": { "type": "string", "title": "Utc" }, "display_at": { "type": "string", "title": "Display At" }, "delivery_state": { "anyOf": [ { "type": "string", "enum": [ "failed", "delayed", "unconfirmed" ] }, { "type": "null" } ], "title": "Delivery State" }, "report_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Report Status" }, "report_diagnostic": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Report Diagnostic" }, "report_confidence": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Report Confidence" }, "eligible_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Eligible At" }, "estimated_send_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Estimated Send At" }, "estimate_state": { "anyOf": [ { "type": "string", "enum": [ "estimated", "preparing", "blocked", "deferred" ] }, { "type": "null" } ], "title": "Estimate State" } }, "additionalProperties": false, "type": "object", "required": [ "item_id", "job", "event", "campaign", "workspace", "step", "sequence_position", "sequence_total", "state", "instant", "recipient", "name", "campaign_state", "workspace_state", "kind", "campaign_timezone", "utc", "display_at" ], "title": "CalendarItem" }, "CalendarPage": { "properties": { "items": { "items": { "$ref": "#/components/schemas/CalendarItem" }, "type": "array", "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "timezone": { "type": "string", "title": "Timezone" }, "view": { "type": "string", "enum": [ "all", "history", "planned" ], "title": "View" }, "observed_at": { "type": "number", "title": "Observed At" }, "planning_pending": { "type": "boolean", "title": "Planning Pending" }, "revision": { "items": { "type": "integer" }, "type": "array", "maxItems": 3, "minItems": 3, "title": "Revision" }, "summary": { "$ref": "#/components/schemas/CalendarSummary" }, "snapshot": { "type": "boolean", "const": false, "title": "Snapshot" }, "semantics": { "type": "string", "enum": [ "soft_estimates_and_recorded_outcomes", "stored_eligibility_and_recorded_outcomes" ], "title": "Semantics" }, "coverage": { "type": "string", "title": "Coverage" }, "days": { "anyOf": [ { "items": { "$ref": "#/components/schemas/CalendarDay" }, "type": "array" }, { "type": "null" } ], "title": "Days" }, "forecast": { "anyOf": [ { "$ref": "#/components/schemas/SendProjectionSummary" }, { "type": "null" } ] }, "windows": { "anyOf": [ { "$ref": "#/components/schemas/CalendarWindows" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "required": [ "items", "next_cursor", "timezone", "view", "observed_at", "planning_pending", "revision", "summary", "snapshot", "semantics", "coverage" ], "title": "CalendarPage" }, "CalendarQueue": { "properties": { "total": { "type": "integer", "minimum": 0.0, "title": "Total" }, "before_interval": { "type": "integer", "minimum": 0.0, "title": "Before Interval" }, "within_interval": { "type": "integer", "minimum": 0.0, "title": "Within Interval" }, "next_24h": { "type": "integer", "minimum": 0.0, "title": "Next 24H" }, "later": { "type": "integer", "minimum": 0.0, "title": "Later" }, "first_touches": { "$ref": "#/components/schemas/CalendarBuckets" }, "follow_ups": { "$ref": "#/components/schemas/CalendarBuckets" } }, "additionalProperties": false, "type": "object", "required": [ "total", "before_interval", "within_interval", "next_24h", "later", "first_touches", "follow_ups" ], "title": "CalendarQueue" }, "CalendarSummary": { "properties": { "planned_jobs": { "additionalProperties": { "type": "integer", "minimum": 0.0 }, "propertyNames": { "enum": [ "queued", "reserved", "dispatching", "unknown" ] }, "type": "object", "title": "Planned Jobs" }, "queue_eligibility": { "$ref": "#/components/schemas/CalendarQueue" }, "historical_attempts": { "additionalProperties": { "type": "integer", "minimum": 0.0 }, "propertyNames": { "enum": [ "accepted", "not_accepted" ] }, "type": "object", "title": "Historical Attempts" }, "bounce_reports": { "type": "integer", "minimum": 0.0, "title": "Bounce Reports" }, "delivery_evidence": { "$ref": "#/components/schemas/CalendarDelivery" }, "scope": { "type": "string", "const": "full_filtered_utc_interval", "title": "Scope" }, "complete": { "type": "boolean", "const": true, "title": "Complete" } }, "additionalProperties": false, "type": "object", "required": [ "planned_jobs", "queue_eligibility", "historical_attempts", "bounce_reports", "delivery_evidence", "scope", "complete" ], "title": "CalendarSummary" }, "CalendarWindow": { "properties": { "campaign": { "type": "string", "title": "Campaign" }, "name": { "type": "string", "title": "Name" }, "timezone": { "type": "string", "title": "Timezone" }, "start": { "type": "number", "title": "Start" }, "end": { "type": "number", "title": "End" } }, "additionalProperties": false, "type": "object", "required": [ "campaign", "name", "timezone", "start", "end" ], "title": "CalendarWindow" }, "CalendarWindows": { "properties": { "items": { "items": { "$ref": "#/components/schemas/CalendarWindow" }, "type": "array", "maxItems": 2048, "title": "Items" }, "complete": { "type": "boolean", "title": "Complete" } }, "additionalProperties": false, "type": "object", "required": [ "items", "complete" ], "title": "CalendarWindows" }, "CampaignAdmissionTarget": { "properties": { "campaign_id": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Campaign Id" }, "expected_campaign_revision": { "type": "integer", "minimum": 1.0, "title": "Expected Campaign Revision" }, "expected_audience_revision": { "type": "integer", "minimum": 1.0, "title": "Expected Audience Revision" }, "expected_sources_revision": { "type": "integer", "minimum": 1.0, "title": "Expected Sources Revision" }, "allow_sending": { "type": "boolean", "title": "Allow Sending", "description": "Explicitly allow admission to a published capacity-funded campaign under its current sending authority.", "default": false } }, "additionalProperties": false, "type": "object", "required": [ "campaign_id", "expected_campaign_revision", "expected_audience_revision", "expected_sources_revision" ], "title": "CampaignAdmissionTarget" }, "CampaignAudiencePage": { "properties": { "items": { "items": { "$ref": "#/components/schemas/CampaignRecipient" }, "type": "array", "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "additionalProperties": false, "type": "object", "required": [ "items", "next_cursor" ], "title": "CampaignAudiencePage" }, "CampaignConflict": { "properties": { "detail": { "$ref": "#/components/schemas/CampaignConflictDetail" } }, "type": "object", "required": [ "detail" ], "title": "CampaignConflict" }, "CampaignConflictDetail": { "properties": { "code": { "type": "string", "title": "Code" }, "loc": { "anyOf": [ { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array" }, { "type": "null" } ], "title": "Loc" } }, "additionalProperties": true, "type": "object", "required": [ "code" ], "title": "CampaignConflictDetail" }, "CampaignCreated": { "properties": { "id": { "type": "string", "title": "Id" }, "state": { "type": "string", "enum": [ "draft", "active", "paused", "complete" ], "title": "State" }, "created_at": { "type": "number", "title": "Created At" }, "revision": { "type": "integer", "title": "Revision" }, "archived": { "type": "integer", "enum": [ 0, 1 ], "title": "Archived" }, "workspace": { "type": "string", "title": "Workspace" }, "expected_contacts": { "type": "integer", "title": "Expected Contacts" }, "next_dispatch": { "type": "number", "title": "Next Dispatch" }, "published_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Published At" }, "import_digest": { "type": "string", "title": "Import Digest" }, "pacing_version": { "type": "integer", "title": "Pacing Version" }, "reply_streak": { "type": "integer", "title": "Reply Streak" }, "queue_due": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Queue Due" }, "ready_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ready At" }, "last_claim": { "type": "number", "title": "Last Claim" }, "send_budget": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Send Budget" }, "authorized_send_price": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Authorized Send Price" }, "send_committed": { "type": "integer", "title": "Send Committed" }, "send_principal": { "type": "string", "title": "Send Principal" }, "audience_revision": { "type": "integer", "title": "Audience Revision" }, "reply_budget": { "type": "integer", "title": "Reply Budget" }, "reply_committed": { "type": "integer", "title": "Reply Committed" }, "authorized_reply_price": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Authorized Reply Price" }, "reply_due": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Reply Due" }, "reply_direct_committed": { "type": "integer", "title": "Reply Direct Committed" }, "commercial_policy_version": { "type": "string", "title": "Commercial Policy Version" }, "spending_mode": { "type": "string", "enum": [ "finite", "capacity" ], "title": "Spending Mode" }, "schedule_not_before": { "type": "number", "title": "Schedule Not Before" }, "plan_revision": { "type": "integer", "title": "Plan Revision" }, "data_sources_revision": { "type": "integer", "title": "Data Sources Revision" }, "name": { "type": "string", "title": "Name" }, "offer": { "type": "string", "title": "Offer" }, "audience_prompt": { "type": "string", "title": "Audience Prompt" }, "steps": { "type": "string", "title": "Steps" }, "schedule": { "type": "string", "title": "Schedule" }, "daily_limit": { "type": "integer", "title": "Daily Limit" }, "sending_pool": { "type": "string", "enum": [ "mailbox", "transactional", "all" ], "title": "Sending Pool" }, "template_format": { "type": "integer", "title": "Template Format" }, "allow_catch_all": { "type": "integer", "enum": [ 0, 1 ], "title": "Allow Catch All" }, "name_cleaning": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name Cleaning" } }, "additionalProperties": false, "type": "object", "required": [ "id", "state", "created_at", "revision", "archived", "workspace", "expected_contacts", "next_dispatch", "published_at", "import_digest", "pacing_version", "reply_streak", "queue_due", "ready_at", "last_claim", "send_budget", "authorized_send_price", "send_committed", "send_principal", "audience_revision", "reply_budget", "reply_committed", "authorized_reply_price", "reply_due", "reply_direct_committed", "commercial_policy_version", "spending_mode", "schedule_not_before", "plan_revision", "data_sources_revision", "name", "offer", "audience_prompt", "steps", "schedule", "daily_limit", "sending_pool", "template_format", "allow_catch_all", "name_cleaning" ], "title": "CampaignCreated" }, "CampaignDetail": { "properties": { "contact_count": { "type": "integer", "title": "Contact Count" }, "total_historical_count": { "type": "integer", "title": "Total Historical Count" }, "first_touches_remaining": { "type": "integer", "title": "First Touches Remaining" }, "remaining_lead_count": { "type": "integer", "title": "Remaining Lead Count" }, "remaining_queue_count": { "type": "integer", "title": "Remaining Queue Count" }, "queued_first_touches": { "type": "integer", "title": "Queued First Touches" }, "queued_followups": { "type": "integer", "title": "Queued Followups" }, "id": { "type": "string", "title": "Id" }, "state": { "type": "string", "enum": [ "draft", "active", "paused", "complete" ], "title": "State" }, "created_at": { "type": "number", "title": "Created At" }, "revision": { "type": "integer", "title": "Revision" }, "archived": { "type": "integer", "enum": [ 0, 1 ], "title": "Archived" }, "workspace": { "type": "string", "title": "Workspace" }, "expected_contacts": { "type": "integer", "title": "Expected Contacts" }, "next_dispatch": { "type": "number", "title": "Next Dispatch" }, "published_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Published At" }, "import_digest": { "type": "string", "title": "Import Digest" }, "pacing_version": { "type": "integer", "title": "Pacing Version" }, "reply_streak": { "type": "integer", "title": "Reply Streak" }, "queue_due": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Queue Due" }, "ready_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ready At" }, "last_claim": { "type": "number", "title": "Last Claim" }, "send_budget": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Send Budget" }, "authorized_send_price": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Authorized Send Price" }, "send_committed": { "type": "integer", "title": "Send Committed" }, "send_principal": { "type": "string", "title": "Send Principal" }, "audience_revision": { "type": "integer", "title": "Audience Revision" }, "reply_budget": { "type": "integer", "title": "Reply Budget" }, "reply_committed": { "type": "integer", "title": "Reply Committed" }, "authorized_reply_price": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Authorized Reply Price" }, "reply_due": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Reply Due" }, "reply_direct_committed": { "type": "integer", "title": "Reply Direct Committed" }, "commercial_policy_version": { "type": "string", "title": "Commercial Policy Version" }, "spending_mode": { "type": "string", "enum": [ "finite", "capacity" ], "title": "Spending Mode" }, "schedule_not_before": { "type": "number", "title": "Schedule Not Before" }, "plan_revision": { "type": "integer", "title": "Plan Revision" }, "data_sources_revision": { "type": "integer", "title": "Data Sources Revision" }, "definition": { "$ref": "#/components/schemas/SavedCampaignDefinition" }, "imported_contacts": { "type": "integer", "title": "Imported Contacts" }, "eligible_contacts": { "type": "integer", "title": "Eligible Contacts" }, "jobs": { "items": { "$ref": "#/components/schemas/CampaignReadJob" }, "type": "array", "maxItems": 1000, "title": "Jobs" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "schedule_advice": { "anyOf": [ { "$ref": "#/components/schemas/ScheduleAdviceResponse" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "required": [ "contact_count", "total_historical_count", "first_touches_remaining", "remaining_lead_count", "remaining_queue_count", "queued_first_touches", "queued_followups", "id", "state", "created_at", "revision", "archived", "workspace", "expected_contacts", "next_dispatch", "published_at", "import_digest", "pacing_version", "reply_streak", "queue_due", "ready_at", "last_claim", "send_budget", "authorized_send_price", "send_committed", "send_principal", "audience_revision", "reply_budget", "reply_committed", "authorized_reply_price", "reply_due", "reply_direct_committed", "commercial_policy_version", "spending_mode", "schedule_not_before", "plan_revision", "data_sources_revision", "definition", "imported_contacts", "eligible_contacts", "jobs", "next_cursor" ], "title": "CampaignDetail" }, "CampaignEligibilityBreakdown": { "properties": { "observed_at": { "type": "number", "title": "Observed At" }, "complete": { "type": "boolean", "title": "Complete" }, "inspected": { "type": "integer", "title": "Inspected" }, "total": { "type": "integer", "title": "Total" }, "counts": { "$ref": "#/components/schemas/EligibilityCounts" }, "reason_counts": { "additionalProperties": { "type": "integer" }, "type": "object", "title": "Reason Counts" }, "contacted_total": { "type": "integer", "title": "Contacted Total" }, "queued_followups": { "type": "integer", "title": "Queued Followups" }, "qualified_upper_bound": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Qualified Upper Bound" }, "recontact_days": { "type": "integer", "const": 30, "title": "Recontact Days", "default": 30 }, "semantics": { "type": "string", "const": "first_email_qualification_not_send_capacity", "title": "Semantics", "default": "first_email_qualification_not_send_capacity" } }, "additionalProperties": false, "type": "object", "required": [ "observed_at", "complete", "inspected", "total", "counts", "reason_counts", "contacted_total", "queued_followups" ], "title": "CampaignEligibilityBreakdown" }, "CampaignExport": { "properties": { "campaign_id": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Campaign Id" }, "status": { "type": "string", "enum": [ "all", "contacted", "not_contacted", "email_ineligible", "name_ineligible", "ineligible", "needs_review", "queued", "upload_results" ], "title": "Status", "default": "all" }, "source_job_id": { "anyOf": [ { "type": "string", "pattern": "^[a-f0-9]{32}$" }, { "type": "null" } ], "title": "Source Job Id" }, "list_id": { "anyOf": [ { "type": "string", "pattern": "^[a-f0-9]{32}$" }, { "type": "null" } ], "title": "List Id" }, "expected_membership_revision": { "anyOf": [ { "type": "integer", "minimum": 1.0 }, { "type": "null" } ], "title": "Expected Membership Revision" }, "max_bytes": { "type": "integer", "maximum": 4294967296.0, "minimum": 1.0, "title": "Max Bytes", "default": 67108864 } }, "additionalProperties": false, "type": "object", "required": [ "campaign_id" ], "title": "CampaignExport" }, "CampaignIn": { "properties": { "list_ids": { "items": { "type": "string", "pattern": "^[a-f0-9]{32}$" }, "type": "array", "maxItems": 50, "title": "List Ids" }, "operation_id": { "anyOf": [ { "type": "string", "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._~-]*$" }, { "type": "null" } ], "title": "Operation Id" }, "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", "description": "Finite campaign outbound sends per local sending day. Zero means unallocated: no new outbound sends or automatic preparation. The selected sending pool, shared capacity and current safeguards still apply.", "default": 0 }, "sending_pool": { "type": "string", "enum": [ "mailbox", "transactional", "all" ], "title": "Sending Pool", "description": "Authorized sending capacity: mailbox by default, transactional or all only with an admin grant. Does not classify message content.", "default": "mailbox" }, "allow_catch_all": { "type": "boolean", "title": "Allow Catch All", "default": false }, "template_format": { "type": "integer", "maximum": 2.0, "minimum": 1.0, "title": "Template Format", "default": 1 }, "name_cleaning": { "anyOf": [ { "$ref": "#/components/schemas/NameMapping" }, { "type": "null" } ] }, "import_digest": { "type": "string", "pattern": "^(?:[0-9a-f]{64})?$", "title": "Import Digest", "default": "" }, "id": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Id" }, "contacts": { "items": { "$ref": "#/components/schemas/Contact" }, "type": "array", "maxItems": 1000, "title": "Contacts" }, "expected_contacts": { "type": "integer", "maximum": 100000.0, "minimum": 0.0, "title": "Expected Contacts", "default": 0 } }, "additionalProperties": false, "type": "object", "required": [ "name", "steps", "id" ], "title": "CampaignIn" }, "CampaignListItem": { "properties": { "contact_count": { "type": "integer", "title": "Contact Count" }, "total_historical_count": { "type": "integer", "title": "Total Historical Count" }, "first_touches_remaining": { "type": "integer", "title": "First Touches Remaining" }, "remaining_lead_count": { "type": "integer", "title": "Remaining Lead Count" }, "remaining_queue_count": { "type": "integer", "title": "Remaining Queue Count" }, "queued_first_touches": { "type": "integer", "title": "Queued First Touches" }, "queued_followups": { "type": "integer", "title": "Queued Followups" }, "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "state": { "type": "string", "enum": [ "draft", "active", "paused", "complete" ], "title": "State" }, "created_at": { "type": "number", "title": "Created At" }, "schedule": { "$ref": "#/components/schemas/Window" }, "revision": { "type": "integer", "title": "Revision" }, "archived": { "type": "integer", "enum": [ 0, 1 ], "title": "Archived" }, "daily_limit": { "type": "integer", "title": "Daily Limit" }, "sending_pool": { "type": "string", "enum": [ "mailbox", "transactional", "all" ], "title": "Sending Pool" }, "allow_catch_all": { "type": "integer", "enum": [ 0, 1 ], "title": "Allow Catch All" } }, "additionalProperties": false, "type": "object", "required": [ "contact_count", "total_historical_count", "first_touches_remaining", "remaining_lead_count", "remaining_queue_count", "queued_first_touches", "queued_followups", "id", "name", "state", "created_at", "schedule", "revision", "archived", "daily_limit", "sending_pool", "allow_catch_all" ], "title": "CampaignListItem" }, "CampaignListMembership": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "state": { "type": "string", "enum": [ "active", "archived" ], "title": "State" } }, "type": "object", "required": [ "id", "name", "state" ], "title": "CampaignListMembership" }, "CampaignListPage": { "properties": { "items": { "items": { "$ref": "#/components/schemas/CampaignListItem" }, "type": "array", "maxItems": 1000, "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "schedule_advice": { "anyOf": [ { "$ref": "#/components/schemas/ScheduleAdviceResponse" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "required": [ "items", "next_cursor" ], "title": "CampaignListPage" }, "CampaignOutlook": { "properties": { "name_quality_counts": { "anyOf": [ { "additionalProperties": { "type": "integer" }, "type": "object" }, { "type": "null" } ], "title": "Name Quality Counts" }, "campaign": { "type": "string", "title": "Campaign" }, "name": { "type": "string", "title": "Name" }, "daily_limit": { "type": "integer", "title": "Daily Limit" }, "queued": { "$ref": "#/components/schemas/SendCounts" }, "due_by_close": { "$ref": "#/components/schemas/SendCounts" }, "pending_first_touches": { "type": "integer", "title": "Pending First Touches" }, "unsettled_sends": { "type": "integer", "title": "Unsettled Sends" }, "remaining_maximum": { "type": "integer", "title": "Remaining Maximum" }, "opens_at": { "type": "number", "title": "Opens At" }, "closes_at": { "type": "number", "title": "Closes At" }, "window_today": { "type": "boolean", "title": "Window Today" }, "blocker": { "type": "string", "title": "Blocker" } }, "type": "object", "required": [ "campaign", "name", "daily_limit", "queued", "due_by_close", "pending_first_touches", "unsettled_sends", "remaining_maximum", "opens_at", "closes_at", "window_today", "blocker" ], "title": "CampaignOutlook" }, "CampaignProjection": { "properties": { "campaign": { "type": "string", "title": "Campaign" }, "cold_target": { "type": "integer", "title": "Cold Target", "default": 0 }, "pending_candidates": { "type": "integer", "title": "Pending Candidates", "default": 0 }, "queued": { "$ref": "#/components/schemas/sequencer__application__send_projection__Counts" }, "blocker": { "type": "string", "title": "Blocker", "default": "" }, "days": { "items": { "$ref": "#/components/schemas/ProjectedDay" }, "type": "array", "title": "Days" } }, "additionalProperties": false, "type": "object", "required": [ "campaign" ], "title": "CampaignProjection" }, "CampaignReadJob": { "properties": { "id": { "type": "string", "title": "Id" }, "message_id": { "type": "string", "title": "Message Id" }, "step": { "type": "integer", "title": "Step" }, "sequence_position": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sequence Position" }, "sequence_total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sequence Total" }, "state": { "type": "string", "enum": [ "queued", "reserved", "dispatching", "accepted", "not_accepted", "unknown", "cancelled" ], "title": "State" }, "error": { "type": "string", "title": "Error" }, "email": { "type": "string", "title": "Email" }, "attempt": { "type": "string", "title": "Attempt" }, "pre_dispatch_failure": { "type": "integer", "enum": [ 0, 1 ], "title": "Pre Dispatch Failure" }, "automatic_recovery_pending": { "type": "integer", "enum": [ 0, 1 ], "title": "Automatic Recovery Pending" }, "has_retries": { "type": "integer", "enum": [ 0, 1 ], "title": "Has Retries" } }, "additionalProperties": false, "type": "object", "required": [ "id", "message_id", "step", "sequence_position", "sequence_total", "state", "error", "email", "attempt", "pre_dispatch_failure", "automatic_recovery_pending", "has_retries" ], "title": "CampaignReadJob" }, "CampaignRecipient": { "properties": { "id": { "type": "string", "title": "Id" }, "email": { "type": "string", "title": "Email" }, "fields": { "additionalProperties": { "$ref": "#/components/schemas/JsonValue" }, "type": "object", "title": "Fields" }, "state": { "type": "string", "title": "State" }, "refill_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Refill Id" }, "eligibility": { "anyOf": [ { "$ref": "#/components/schemas/RecipientEligibility" }, { "type": "null" } ] }, "progress": { "$ref": "#/components/schemas/RecipientProgress" } }, "additionalProperties": false, "type": "object", "required": [ "id", "email", "fields", "state", "refill_id", "progress" ], "title": "CampaignRecipient" }, "CampaignSave": { "properties": { "operation_id": { "type": "string", "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._~-]*$", "title": "Operation Id" }, "expected_revision": { "type": "integer", "minimum": 1.0, "title": "Expected Revision" }, "name": { "anyOf": [ { "type": "string", "maxLength": 200, "minLength": 1 }, { "type": "null" } ], "title": "Name" }, "offer": { "anyOf": [ { "type": "string", "maxLength": 10000 }, { "type": "null" } ], "title": "Offer" }, "audience_prompt": { "anyOf": [ { "type": "string", "maxLength": 10000 }, { "type": "null" } ], "title": "Audience Prompt" }, "steps": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Step" }, "type": "array", "maxItems": 10, "minItems": 1 }, { "type": "null" } ], "title": "Steps" }, "schedule": { "anyOf": [ { "$ref": "#/components/schemas/Window" }, { "type": "null" } ] }, "daily_limit": { "anyOf": [ { "type": "integer", "maximum": 15000.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Daily Limit", "description": "Finite daily allocation; zero stops new campaign outbound work without cancelling queued originals. Omission preserves the current allocation; null is invalid." }, "sending_pool": { "anyOf": [ { "type": "string", "enum": [ "mailbox", "transactional", "all" ] }, { "type": "null" } ], "title": "Sending Pool" }, "allow_catch_all": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Allow Catch All" }, "template_format": { "anyOf": [ { "type": "integer", "maximum": 2.0, "minimum": 1.0 }, { "type": "null" } ], "title": "Template Format" }, "name_cleaning": { "anyOf": [ { "$ref": "#/components/schemas/NameMapping" }, { "type": "null" } ] }, "recipients": { "items": { "$ref": "#/components/schemas/RecipientFields" }, "type": "array", "maxItems": 25, "title": "Recipients" }, "sources": { "anyOf": [ { "$ref": "#/components/schemas/SourceSelection" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "required": [ "operation_id", "expected_revision" ], "title": "CampaignSave", "examples": [ { "expected_revision": 7, "operation_id": "copy-1", "steps": [ { "body": "Updated first email", "id": 0, "subject": "An introduction" }, { "body": "Following up", "delay_seconds": 259200, "id": 4, "subject": "Re:" } ] }, { "expected_revision": 8, "operation_id": "append-1", "steps": [ { "body": "First email", "id": 0, "subject": "An introduction" }, { "body": "Following up", "delay_seconds": 259200, "id": 4, "subject": "Re:" }, { "body": "One final thought", "delay_seconds": 259200, "subject": "Re:" } ] }, { "expected_revision": 9, "operation_id": "reorder-1", "steps": [ { "body": "First email", "id": 0, "subject": "An introduction" }, { "body": "Now second", "delay_seconds": 172800, "id": 9, "subject": "Re:" }, { "body": "Now third", "delay_seconds": 259200, "id": 4, "subject": "Re:" } ] } ] }, "CampaignSource": { "properties": { "id": { "type": "string", "title": "Id" }, "campaign_id": { "type": "string", "title": "Campaign Id" }, "list_id": { "type": "string", "title": "List Id" }, "state": { "type": "string", "enum": [ "connected", "disconnected" ], "title": "State" }, "revision": { "type": "integer", "title": "Revision" }, "list_name": { "type": "string", "title": "List Name" }, "list_state": { "type": "string", "enum": [ "active", "archived" ], "title": "List State" }, "member_count": { "type": "integer", "title": "Member Count" }, "membership_revision": { "type": "integer", "title": "Membership Revision" }, "created_at": { "type": "string", "title": "Created At" }, "updated_at": { "type": "string", "title": "Updated At" } }, "type": "object", "required": [ "id", "campaign_id", "list_id", "state", "revision", "list_name", "list_state", "member_count", "membership_revision", "created_at", "updated_at" ], "title": "CampaignSource" }, "CampaignStartResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "campaign": { "type": "string", "title": "Campaign" }, "state": { "type": "string", "enum": [ "waiting", "started", "cancelled", "failed" ], "title": "State" }, "cancel_requested": { "type": "boolean", "title": "Cancel Requested" }, "blocker": { "type": "string", "title": "Blocker" }, "capacity_operation": { "type": "string", "title": "Capacity Operation" }, "capacity_state": { "type": "string", "enum": [ "requested", "committing", "active", "expired", "cancelled" ], "title": "Capacity State" }, "capacity_acquired_by_start": { "type": "boolean", "title": "Capacity Acquired By Start" }, "lease_until": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lease Until" }, "deadline": { "type": "number", "title": "Deadline" }, "capacity_remains_prepaid": { "type": "boolean", "title": "Capacity Remains Prepaid" }, "initial_capacity_charge_cents": { "type": "integer", "title": "Initial Capacity Charge Cents" }, "initial_capacity_held_cents": { "type": "integer", "title": "Initial Capacity Held Cents" }, "recovery": { "$ref": "#/components/schemas/StartRecovery" } }, "additionalProperties": false, "type": "object", "required": [ "id", "campaign", "state", "cancel_requested", "blocker", "capacity_operation", "capacity_state", "capacity_acquired_by_start", "lease_until", "deadline", "capacity_remains_prepaid", "initial_capacity_charge_cents", "initial_capacity_held_cents", "recovery" ], "title": "CampaignStartResponse" }, "CampaignState": { "properties": { "state": { "type": "string", "enum": [ "active", "paused" ], "title": "State" } }, "additionalProperties": false, "type": "object", "required": [ "state" ], "title": "CampaignState" }, "CampaignSummary": { "properties": { "name_quality_counts": { "anyOf": [ { "additionalProperties": { "type": "integer" }, "type": "object" }, { "type": "null" } ], "title": "Name Quality Counts" }, "definition": { "type": "string", "const": "campaign-observation-v1", "title": "Definition" }, "campaign": { "type": "string", "title": "Campaign" }, "revision": { "type": "integer", "title": "Revision" }, "state": { "type": "string", "title": "State" }, "observed_at": { "type": "number", "title": "Observed At" }, "local_date": { "type": "string", "title": "Local Date" }, "timezone": { "type": "string", "title": "Timezone" }, "local_day_starts_at": { "type": "number", "title": "Local Day Starts At" }, "local_day_ends_at": { "type": "number", "title": "Local Day Ends At" }, "account_day_ends_at": { "type": "number", "title": "Account Day Ends At" }, "sent_today": { "type": "integer", "title": "Sent Today" }, "automatic_slots_used": { "type": "integer", "title": "Automatic Slots Used" }, "campaign_slots_remaining": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Campaign Slots Remaining" }, "workspace_remaining": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Workspace Remaining" }, "due_followups_bound_to_exhausted_senders": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Due Followups Bound To Exhausted Senders" }, "verified_first_touches_remaining": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Verified First Touches Remaining" }, "unprepared_first_touches": { "type": "integer", "title": "Unprepared First Touches" }, "verification_unresolved_first_touches": { "type": "integer", "title": "Verification Unresolved First Touches" }, "verification_cooldown_until": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Verification Cooldown Until" }, "backlog": { "$ref": "#/components/schemas/QueueBacklog" }, "window_pressure": { "anyOf": [ { "$ref": "#/components/schemas/WindowPressure" }, { "type": "null" } ] }, "next_eligible_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Next Eligible At" }, "idle_reason": { "type": "string", "title": "Idle Reason" }, "candidate_search_complete": { "type": "boolean", "title": "Candidate Search Complete" }, "semantics": { "type": "string", "const": "current_gates_and_recorded_attempts_not_delivery_promise", "title": "Semantics" } }, "type": "object", "required": [ "definition", "campaign", "revision", "state", "observed_at", "local_date", "timezone", "local_day_starts_at", "local_day_ends_at", "account_day_ends_at", "sent_today", "automatic_slots_used", "campaign_slots_remaining", "workspace_remaining", "due_followups_bound_to_exhausted_senders", "verified_first_touches_remaining", "unprepared_first_touches", "verification_unresolved_first_touches", "verification_cooldown_until", "backlog", "window_pressure", "next_eligible_at", "idle_reason", "candidate_search_complete", "semantics" ], "title": "CampaignSummary" }, "CampaignVerificationPage": { "properties": { "policy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Policy" }, "observed_at": { "type": "number", "title": "Observed At" }, "revision": { "type": "integer", "title": "Revision" }, "editable": { "type": "boolean", "title": "Editable" }, "checkable": { "type": "boolean", "title": "Checkable" }, "items": { "items": { "$ref": "#/components/schemas/RecipientVerification" }, "type": "array", "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "additionalProperties": false, "type": "object", "required": [ "policy", "observed_at", "revision", "editable", "checkable", "items", "next_cursor" ], "title": "CampaignVerificationPage" }, "CampaignWindow": { "properties": { "local_date": { "type": "string", "title": "Local Date" }, "timezone": { "type": "string", "title": "Timezone" }, "intervals": { "items": { "items": { "type": "number" }, "type": "array" }, "type": "array", "title": "Intervals", "description": "UTC epoch [start, end] pairs for this local day." }, "schedule_key": { "type": "string", "title": "Schedule Key" }, "requested_target": { "type": "integer", "title": "Requested Target" }, "recorded_at": { "type": "number", "title": "Recorded At" }, "attempts": { "$ref": "#/components/schemas/WindowAttempts" }, "campaign_activity": { "$ref": "#/components/schemas/WindowActivity" }, "blockers_observed": { "items": { "$ref": "#/components/schemas/WindowBlocker" }, "type": "array", "title": "Blockers Observed" }, "target_gap": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Target Gap" }, "phase": { "type": "string", "enum": [ "scheduled", "closed", "open", "between_intervals" ], "title": "Phase" } }, "additionalProperties": false, "type": "object", "required": [ "local_date", "timezone", "intervals", "schedule_key", "requested_target", "recorded_at", "attempts", "campaign_activity", "blockers_observed", "target_gap", "phase" ], "title": "CampaignWindow" }, "CampaignWindowsPage": { "properties": { "items": { "items": { "$ref": "#/components/schemas/CampaignWindow" }, "type": "array", "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "observed_at": { "type": "number", "title": "Observed At" } }, "additionalProperties": false, "type": "object", "required": [ "items", "next_cursor", "observed_at" ], "title": "CampaignWindowsPage" }, "CapacityAllocation": { "properties": { "mailbox": { "type": "string", "title": "Mailbox" }, "domain": { "type": "string", "title": "Domain" }, "generation": { "type": "string", "title": "Generation" }, "daily_capacity": { "type": "integer", "title": "Daily Capacity" }, "revision": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Revision" }, "lease_until": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lease Until" }, "consumer_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Consumer Id" }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" }, "drain_until": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Drain Until" }, "term_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Term Version" }, "funding_reference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Funding Reference" }, "funded_period_start": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Funded Period Start" } }, "additionalProperties": false, "type": "object", "required": [ "mailbox", "domain", "generation", "daily_capacity" ], "title": "CapacityAllocation" }, "CapacityAttention": { "properties": { "kind": { "type": "string", "enum": [ "none", "review", "unfunded", "unavailable", "recovery", "renewal", "deficit" ], "title": "Kind" }, "title": { "type": "string", "title": "Title" }, "description": { "type": "string", "title": "Description" }, "destination": { "type": "string", "const": "capacity", "title": "Destination" }, "observed_at": { "type": "number", "title": "Observed At" } }, "additionalProperties": false, "type": "object", "required": [ "kind", "title", "description", "destination", "observed_at" ], "title": "CapacityAttention" }, "CapacityConfirmationBody": { "properties": { "recurring_consent": { "type": "string", "title": "Recurring Consent" } }, "additionalProperties": false, "type": "object", "title": "CapacityConfirmationBody" }, "CapacityConfirmationLink": { "properties": { "method": { "type": "string", "const": "POST", "title": "Method" }, "path": { "type": "string", "title": "Path" }, "body": { "$ref": "#/components/schemas/CapacityConfirmationBody" } }, "additionalProperties": false, "type": "object", "required": [ "method", "path", "body" ], "title": "CapacityConfirmationLink" }, "CapacityConfirmationStep": { "properties": { "kind": { "type": "string", "enum": [ "reactivation", "expansion" ], "title": "Kind" }, "id": { "type": "string", "title": "Id" }, "state": { "type": "string", "title": "State" }, "charged_cents": { "type": "integer", "title": "Charged Cents" }, "held_cents": { "type": "integer", "title": "Held Cents" }, "error": { "type": "string", "title": "Error" } }, "additionalProperties": false, "type": "object", "required": [ "kind", "id", "state", "charged_cents", "held_cents" ], "title": "CapacityConfirmationStep" }, "CapacityConsentIn": { "properties": { "recurring_consent": { "anyOf": [ { "type": "string", "maxLength": 32 }, { "type": "null" } ], "title": "Recurring Consent" } }, "additionalProperties": false, "type": "object", "title": "CapacityConsentIn" }, "CapacityExpansionResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "activation": { "type": "string", "title": "Activation" }, "state": { "type": "string", "enum": [ "quoted", "requested", "committing", "applied", "cancelled", "expired" ], "title": "State" }, "desired_daily_sends": { "type": "integer", "title": "Desired Daily Sends" }, "previous_daily_sends": { "type": "integer", "title": "Previous Daily Sends" }, "maximum_additional_cents": { "type": "integer", "title": "Maximum Additional Cents" }, "currency": { "type": "string", "const": "USD", "title": "Currency" }, "lease_until": { "type": "string", "title": "Lease Until" }, "period_seconds": { "type": "integer", "title": "Period Seconds" }, "maximum_next_term_cents": { "type": "integer", "title": "Maximum Next Term Cents" }, "rate_version": { "type": "string", "title": "Rate Version" }, "expires_at": { "type": "number", "title": "Expires At" }, "renewal": { "$ref": "#/components/schemas/RecordedCapacityRenewal" }, "renewal_budget_increase": { "type": "string", "const": "actual_additional_cents", "title": "Renewal Budget Increase" }, "cancel_requested": { "type": "boolean", "title": "Cancel Requested" }, "blocker": { "type": "string", "title": "Blocker" }, "receipt": { "anyOf": [ { "$ref": "#/components/schemas/ExpansionReceipt" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "required": [ "id", "activation", "state", "desired_daily_sends", "previous_daily_sends", "maximum_additional_cents", "currency", "lease_until", "period_seconds", "maximum_next_term_cents", "rate_version", "expires_at", "renewal", "renewal_budget_increase", "cancel_requested", "blocker", "receipt" ], "title": "CapacityExpansionResponse" }, "CapacityMandate": { "properties": { "revision": { "type": "integer", "title": "Revision" }, "desired": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Desired" }, "maximum_cents": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Maximum Cents" }, "next_attempt": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Next Attempt" }, "error": { "type": "string", "title": "Error" }, "recovery_request": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Recovery Request" }, "attempts": { "type": "integer", "title": "Attempts" }, "workspace": { "type": "string", "title": "Workspace" }, "rate_version": { "type": "string", "title": "Rate Version" }, "source_request": { "type": "string", "title": "Source Request" }, "updated_at": { "type": "number", "title": "Updated At" } }, "additionalProperties": false, "type": "object", "required": [ "revision", "desired", "maximum_cents", "next_attempt", "error", "recovery_request", "attempts" ], "title": "CapacityMandate" }, "CapacityNextTerm": { "properties": { "effective_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Effective At" }, "reserved_daily_sends": { "type": "integer", "title": "Reserved Daily Sends" }, "term_cents": { "type": "integer", "title": "Term Cents" }, "state": { "type": "string", "enum": [ "no_term", "not_renewing", "renewal_pending", "renewal_preference_not_purchase", "paid_pending_boundary", "expired_or_released" ], "title": "State" }, "blocker": { "type": "string", "title": "Blocker" }, "funding_confirmed": { "type": "boolean", "title": "Funding Confirmed" }, "ends_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ends At" } }, "additionalProperties": false, "type": "object", "required": [ "effective_at", "reserved_daily_sends", "term_cents", "state", "blocker", "funding_confirmed" ], "title": "CapacityNextTerm" }, "CapacityNow": { "properties": { "observed_at": { "type": "number", "title": "Observed At" }, "account_daily_limit": { "type": "integer", "title": "Account Daily Limit" }, "account_committed_today": { "type": "integer", "title": "Account Committed Today" }, "account_remaining_today": { "type": "integer", "title": "Account Remaining Today" }, "account_resets_at": { "type": "string", "title": "Account Resets At" }, "reserved_daily_sends": { "type": "integer", "title": "Reserved Daily Sends" }, "term_ends_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Term Ends At" }, "immediately_sendable": { "type": "null", "title": "Immediately Sendable" }, "semantics": { "type": "string", "const": "account_allowance_is_not_physical_sendability", "title": "Semantics" } }, "additionalProperties": false, "type": "object", "required": [ "observed_at", "account_daily_limit", "account_committed_today", "account_remaining_today", "account_resets_at", "reserved_daily_sends", "term_ends_at", "immediately_sendable", "semantics" ], "title": "CapacityNow" }, "CapacityOperation": { "properties": { "id": { "type": "string", "title": "Id" }, "period_seconds": { "type": "integer", "title": "Period Seconds" }, "created_at": { "type": "number", "title": "Created At" }, "state": { "type": "string", "enum": [ "requested", "committing", "active", "expired", "cancelled", "lease_expired", "waiting", "draining", "awaiting_handoff", "released", "superseded" ], "title": "State" }, "release": { "anyOf": [ { "$ref": "#/components/schemas/CapacityRelease" }, { "type": "null" } ] }, "recovery": { "$ref": "#/components/schemas/CapacityRecovery" }, "desired_daily_sends": { "type": "integer", "title": "Desired Daily Sends" }, "allocated_daily_sends": { "type": "integer", "title": "Allocated Daily Sends" }, "pending_term": { "anyOf": [ { "$ref": "#/components/schemas/PendingCapacityTerm" }, { "type": "null" } ] }, "pending_expansion": { "anyOf": [ { "$ref": "#/components/schemas/PendingCapacityExpansion" }, { "type": "null" } ] }, "reactivation": { "anyOf": [ { "$ref": "#/components/schemas/ReactivationSummary" }, { "type": "null" } ] }, "reactivation_review_supported": { "type": "boolean", "title": "Reactivation Review Supported" }, "lease_until": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lease Until" }, "released_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Released At" }, "rate_version": { "type": "string", "title": "Rate Version" }, "cents_per_block_term": { "type": "integer", "title": "Cents Per Block Term" }, "term_cents": { "type": "integer", "title": "Term Cents" }, "cancel_requested": { "type": "boolean", "title": "Cancel Requested" }, "blocker": { "type": "string", "title": "Blocker" } }, "additionalProperties": false, "type": "object", "required": [ "id", "period_seconds", "created_at", "state", "release", "recovery", "desired_daily_sends", "allocated_daily_sends", "pending_term", "pending_expansion", "reactivation", "reactivation_review_supported", "lease_until", "released_at", "rate_version", "cents_per_block_term", "term_cents", "cancel_requested", "blocker" ], "title": "CapacityOperation" }, "CapacityPage_CapacityExpansionResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/CapacityExpansionResponse" }, "type": "array", "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "additionalProperties": false, "type": "object", "required": [ "items", "next_cursor" ], "title": "CapacityPage[CapacityExpansionResponse]" }, "CapacityPage_CapacityOperation_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/CapacityOperation" }, "type": "array", "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "additionalProperties": false, "type": "object", "required": [ "items", "next_cursor" ], "title": "CapacityPage[CapacityOperation]" }, "CapacityPage_CapacityReactivationResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/CapacityReactivationResponse" }, "type": "array", "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "additionalProperties": false, "type": "object", "required": [ "items", "next_cursor" ], "title": "CapacityPage[CapacityReactivationResponse]" }, "CapacityQuote": { "properties": { "id": { "type": "string", "title": "Id" }, "desired_daily_sends": { "type": "integer", "title": "Desired Daily Sends" }, "currency": { "type": "string", "const": "USD", "title": "Currency" }, "cents_per_block_term": { "type": "integer", "title": "Cents Per Block Term" }, "rate_version": { "type": "string", "title": "Rate Version" }, "maximum_initial_term_cents": { "type": "integer", "title": "Maximum Initial Term Cents" }, "recurring_max_cents": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Recurring Max Cents" }, "expires_at": { "type": "number", "title": "Expires At" }, "period_seconds": { "type": "integer", "title": "Period Seconds" }, "semantics": { "type": "string", "const": "price_ceiling_not_stock_reservation", "title": "Semantics" } }, "additionalProperties": false, "type": "object", "required": [ "id", "desired_daily_sends", "currency", "cents_per_block_term", "rate_version", "maximum_initial_term_cents", "expires_at", "period_seconds", "semantics" ], "title": "CapacityQuote" }, "CapacityReactivationResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "source_operation": { "type": "string", "title": "Source Operation" }, "state": { "type": "string", "enum": [ "quoted", "pending", "active", "cancelled" ], "title": "State" }, "capacity_operation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Capacity Operation" }, "allocated_daily_sends": { "type": "integer", "title": "Allocated Daily Sends" }, "term_cents": { "type": "integer", "title": "Term Cents" }, "rate_version": { "type": "string", "title": "Rate Version" }, "cents_per_block_term": { "type": "integer", "title": "Cents Per Block Term" }, "period_seconds": { "type": "integer", "title": "Period Seconds" }, "expires_at": { "type": "number", "title": "Expires At" }, "confirmed_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Confirmed At" }, "blocker": { "type": "string", "title": "Blocker" }, "semantics": { "type": "string", "const": "new_paid_term_on_retained_stock", "title": "Semantics" }, "automatic_campaign_restart": { "type": "boolean", "const": false, "title": "Automatic Campaign Restart" }, "cancel_requested": { "type": "boolean", "title": "Cancel Requested" }, "resize_target": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Resize Target" }, "maximum_additional_cents": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Maximum Additional Cents" }, "maximum_next_term_cents": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Maximum Next Term Cents" } }, "additionalProperties": false, "type": "object", "required": [ "id", "source_operation", "state", "capacity_operation", "allocated_daily_sends", "term_cents", "rate_version", "cents_per_block_term", "period_seconds", "expires_at", "confirmed_at", "blocker", "semantics", "automatic_campaign_restart", "cancel_requested" ], "title": "CapacityReactivationResponse" }, "CapacityRecovery": { "properties": { "applicable": { "type": "boolean", "title": "Applicable" }, "replacement_needed": { "type": "integer", "title": "Replacement Needed" }, "restricted": { "type": "integer", "title": "Restricted" }, "source_last_polled_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Source Last Polled At" }, "source_poll_failed": { "type": "boolean", "title": "Source Poll Failed" } }, "additionalProperties": false, "type": "object", "required": [ "applicable", "replacement_needed", "restricted", "source_last_polled_at", "source_poll_failed" ], "title": "CapacityRecovery" }, "CapacityRelease": { "properties": { "state": { "type": "string", "enum": [ "waiting", "draining", "awaiting_handoff", "released", "superseded" ], "title": "State" }, "superseded_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Superseded By" }, "reason": { "type": "string", "title": "Reason" }, "requested_at": { "type": "number", "title": "Requested At" }, "blocker": { "type": "string", "title": "Blocker" } }, "additionalProperties": false, "type": "object", "required": [ "state", "superseded_by", "reason", "requested_at", "blocker" ], "title": "CapacityRelease" }, "CapacityRequestConfirmation": { "properties": { "id": { "type": "string", "title": "Id" }, "action": { "type": "string", "enum": [ "acquire", "expand", "reactivate", "retain", "stop", "no_change" ], "title": "Action" }, "desired_daily_sends": { "type": "integer", "title": "Desired Daily Sends" }, "review": { "$ref": "#/components/schemas/CapacityRequestReview" }, "steps": { "items": { "$ref": "#/components/schemas/CapacityConfirmationStep" }, "type": "array", "title": "Steps" }, "state": { "type": "string", "enum": [ "confirming", "completed", "failed", "capacity_committed_limit_unchanged" ], "title": "State" }, "blocker": { "type": "string", "title": "Blocker" }, "next_attempt_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Next Attempt At" }, "availability_eta": { "type": "null", "title": "Availability Eta" } }, "additionalProperties": false, "type": "object", "required": [ "id", "action", "desired_daily_sends", "review", "steps", "state", "blocker", "next_attempt_at", "availability_eta" ], "title": "CapacityRequestConfirmation" }, "CapacityRequestIncomplete": { "properties": { "id": { "type": "string", "title": "Id" }, "state": { "type": "string", "const": "preparation_incomplete", "title": "State" }, "action": { "type": "string", "enum": [ "acquire", "expand", "reactivate", "retain", "stop", "no_change" ], "title": "Action" }, "blocker": { "type": "string", "title": "Blocker" }, "recovery": { "type": "string", "title": "Recovery" }, "availability_eta": { "type": "null", "title": "Availability Eta" } }, "additionalProperties": false, "type": "object", "required": [ "id", "state", "action", "blocker", "recovery", "availability_eta" ], "title": "CapacityRequestIncomplete" }, "CapacityRequestReview": { "properties": { "id": { "type": "string", "title": "Id" }, "desired_daily_sends": { "type": "integer", "title": "Desired Daily Sends" }, "action": { "type": "string", "enum": [ "acquire", "expand", "reactivate", "retain", "stop", "no_change" ], "title": "Action" }, "source_operation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Operation" }, "review": { "anyOf": [ { "$ref": "#/components/schemas/CapacityQuote" }, { "$ref": "#/components/schemas/CapacityExpansionResponse" }, { "$ref": "#/components/schemas/CapacityReactivationResponse" }, { "$ref": "#/components/schemas/RetentionPreview" }, { "$ref": "#/components/schemas/StopCapacityReview" }, { "type": "null" } ], "title": "Review" }, "terms": { "$ref": "#/components/schemas/CapacityTerms" }, "confirmation": { "$ref": "#/components/schemas/CapacityConfirmationLink" }, "state": { "type": "string", "const": "review_ready", "title": "State" }, "availability_eta": { "type": "null", "title": "Availability Eta" }, "semantics": { "type": "string", "const": "review_only_confirmation_changes_paid_capacity", "title": "Semantics" }, "capacity_revision": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Capacity Revision" } }, "additionalProperties": false, "type": "object", "required": [ "id", "desired_daily_sends", "action", "source_operation", "review", "terms", "confirmation", "state", "availability_eta", "semantics" ], "title": "CapacityRequestReview" }, "CapacityTerms": { "properties": { "currency": { "type": "string", "const": "USD", "title": "Currency" }, "maximum_immediate_charge_cents": { "type": "integer", "title": "Maximum Immediate Charge Cents" }, "refund_cents": { "type": "integer", "title": "Refund Cents" }, "next_term_cents": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Next Term Cents" }, "next_term_is_maximum": { "type": "boolean", "title": "Next Term Is Maximum" }, "allocated_daily_sends": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Allocated Daily Sends" }, "capacity_effective_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Capacity Effective At" }, "account_allowance_effective": { "type": "string", "enum": [ "paid_term_boundary", "on_completion" ], "title": "Account Allowance Effective" }, "renewal_enabled": { "type": "boolean", "title": "Renewal Enabled" }, "campaign_limits_changed": { "type": "boolean", "const": false, "title": "Campaign Limits Changed" }, "partial_success_possible": { "type": "boolean", "title": "Partial Success Possible" }, "pending_commitments_may_complete": { "type": "boolean", "title": "Pending Commitments May Complete" }, "already_paid_term": { "$ref": "#/components/schemas/PaidCapacityTerm" }, "renewal_mode": { "type": "string", "const": "recurring", "title": "Renewal Mode" }, "renewal_period_seconds": { "type": "integer", "title": "Renewal Period Seconds" }, "renewal_payment_source": { "type": "string", "const": "wallet", "title": "Renewal Payment Source" }, "renewal_stop": { "type": "string", "const": "confirmed_capacity_zero", "title": "Renewal Stop" }, "renewal_maximum_cents": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Renewal Maximum Cents" }, "renewal_policy_revision": { "type": "integer", "title": "Renewal Policy Revision" }, "recovery_policy": { "type": "string", "title": "Recovery Policy" }, "recovery": { "type": "string", "title": "Recovery" } }, "additionalProperties": false, "type": "object", "required": [ "currency", "maximum_immediate_charge_cents", "refund_cents", "next_term_cents", "next_term_is_maximum", "allocated_daily_sends", "capacity_effective_at", "account_allowance_effective", "renewal_enabled", "campaign_limits_changed", "partial_success_possible" ], "title": "CapacityTerms" }, "CapacityTimeline": { "properties": { "now": { "$ref": "#/components/schemas/CapacityNow" }, "after_term": { "$ref": "#/components/schemas/CapacityNextTerm" }, "campaign_effect": { "type": "string", "const": "campaign_limits_unchanged_shared_account_and_physical_limits_apply", "title": "Campaign Effect" } }, "additionalProperties": false, "type": "object", "required": [ "now", "after_term", "campaign_effect" ], "title": "CapacityTimeline" }, "CardChangeResult": { "properties": { "id": { "type": "string", "title": "Id" }, "completed": { "type": "boolean", "const": true, "title": "Completed" }, "revision": { "type": "integer", "title": "Revision" }, "replayed": { "type": "boolean", "title": "Replayed", "default": false } }, "additionalProperties": false, "type": "object", "required": [ "id", "completed", "revision" ], "title": "CardChangeResult" }, "CardRemovalOriginal": { "properties": { "id": { "type": "string", "title": "Id" }, "method": { "type": "string", "title": "Method" }, "revision": { "type": "integer", "title": "Revision" } }, "additionalProperties": false, "type": "object", "required": [ "id", "method", "revision" ], "title": "CardRemovalOriginal" }, "CardRemovalRejected": { "properties": { "id": { "type": "string", "title": "Id" }, "method": { "type": "string", "title": "Method" }, "revision": { "type": "integer", "title": "Revision" }, "completed": { "type": "boolean", "const": false, "title": "Completed" }, "outcome": { "type": "string", "const": "rejected_no_effect", "title": "Outcome" }, "reason": { "type": "string", "const": "subscription_replace_default_card_first", "title": "Reason" }, "replayed": { "type": "boolean", "title": "Replayed", "default": false } }, "additionalProperties": false, "type": "object", "required": [ "id", "method", "revision", "completed", "outcome", "reason" ], "title": "CardRemovalRejected" }, "CardRequest": { "properties": { "id": { "type": "string", "maxLength": 128, "minLength": 1, "pattern": "^[^_].*$", "title": "Id" }, "revision": { "type": "integer", "minimum": 0.0, "title": "Revision" } }, "additionalProperties": false, "type": "object", "required": [ "id", "revision" ], "title": "CardRequest" }, "CardSetupResult": { "properties": { "id": { "type": "string", "title": "Id" }, "client_secret": { "type": "string", "title": "Client Secret" }, "revision": { "type": "integer", "title": "Revision" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, "additionalProperties": false, "type": "object", "required": [ "id", "client_secret", "revision", "status" ], "title": "CardSetupResult" }, "CatalogueSchema": { "properties": { "enabled": { "type": "boolean", "title": "Enabled" }, "reason": { "anyOf": [ { "type": "string", "const": "search_not_configured" }, { "type": "null" } ], "title": "Reason" }, "version": { "type": "string", "const": "dataset-1", "title": "Version", "default": "dataset-1" }, "data_source": { "type": "string", "enum": [ "people", "companies" ], "title": "Data Source" }, "field_definitions": { "additionalProperties": { "$ref": "#/components/schemas/FieldDefinition" }, "type": "object", "title": "Field Definitions" }, "preview_fields": { "items": { "type": "string" }, "type": "array", "title": "Preview Fields" }, "export_fields": { "items": { "type": "string" }, "type": "array", "title": "Export Fields" }, "default_export_fields": { "items": { "type": "string" }, "type": "array", "title": "Default Export Fields" }, "sort_fields": { "items": { "type": "string" }, "type": "array", "title": "Sort Fields" }, "identifiers": { "additionalProperties": { "$ref": "#/components/schemas/IdentifierDefinition" }, "type": "object", "title": "Identifiers" }, "filter_options": { "anyOf": [ { "$ref": "#/components/schemas/FilterOptions" }, { "type": "null" } ] }, "limits": { "anyOf": [ { "additionalProperties": { "type": "integer" }, "type": "object" }, { "type": "null" } ], "title": "Limits" }, "domain_sets": { "anyOf": [ { "$ref": "#/components/schemas/DomainSetCapabilities" }, { "type": "null" } ] } }, "type": "object", "required": [ "enabled", "data_source" ], "title": "CatalogueSchema" }, "CheckPolicyDisable": { "properties": { "expected_revision": { "type": "integer", "minimum": 0.0, "title": "Expected Revision" }, "enabled": { "type": "boolean", "const": false, "title": "Enabled" }, "terms": { "type": "null", "title": "Terms" } }, "additionalProperties": false, "type": "object", "required": [ "expected_revision", "enabled" ], "title": "CheckPolicyDisable" }, "CheckPolicyView": { "properties": { "list_id": { "type": "string", "title": "List Id" }, "available": { "type": "boolean", "title": "Available" }, "revision": { "type": "integer", "title": "Revision" }, "enabled": { "type": "boolean", "title": "Enabled" }, "state": { "type": "string", "enum": [ "off", "ready", "running", "paused", "exhausted" ], "title": "State" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" }, "terms": { "anyOf": [ { "$ref": "#/components/schemas/CheckTerms" }, { "type": "null" } ] }, "used_rows": { "type": "integer", "title": "Used Rows" }, "used_provider_requests": { "type": "integer", "title": "Used Provider Requests" }, "used_rounds": { "type": "integer", "title": "Used Rounds" }, "round_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Round Id" }, "next_due": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Next Due" } }, "type": "object", "required": [ "list_id", "available", "revision", "enabled", "state", "reason", "terms", "used_rows", "used_provider_requests", "used_rounds", "round_id", "next_due" ], "title": "CheckPolicyView" }, "CheckRoundView": { "properties": { "id": { "type": "string", "title": "Id" }, "policy_revision": { "type": "integer", "title": "Policy Revision" }, "membership_revision": { "type": "integer", "title": "Membership Revision" }, "reserved_rows": { "type": "integer", "title": "Reserved Rows" }, "provider_requests": { "type": "integer", "title": "Provider Requests" }, "selection_id": { "type": "string", "title": "Selection Id" }, "job_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Job Id" }, "selection_state": { "type": "string", "title": "Selection State" }, "job_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Job State" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" }, "created_at": { "type": "number", "title": "Created At" } }, "type": "object", "required": [ "id", "policy_revision", "membership_revision", "reserved_rows", "provider_requests", "selection_id", "job_id", "selection_state", "job_state", "reason", "created_at" ], "title": "CheckRoundView" }, "CheckTerms": { "properties": { "policy_id": { "type": "string", "const": "source-check-list-v1", "title": "Policy Id" }, "interval_seconds": { "type": "integer", "maximum": 2592000.0, "minimum": 3600.0, "title": "Interval Seconds" }, "max_records_per_round": { "type": "integer", "maximum": 5000000.0, "minimum": 1.0, "title": "Max Records Per Round" }, "max_total_rows": { "type": "integer", "maximum": 9007199254740991.0, "minimum": 1.0, "title": "Max Total Rows" }, "max_provider_requests": { "type": "integer", "maximum": 9007199254740991.0, "minimum": 1.0, "title": "Max Provider Requests" }, "max_rounds": { "type": "integer", "maximum": 9007199254740991.0, "minimum": 1.0, "title": "Max Rounds" }, "expires_at": { "type": "number", "exclusiveMaximum": 253402300800.0, "exclusiveMinimum": 0.0, "title": "Expires At" } }, "additionalProperties": false, "type": "object", "required": [ "policy_id", "interval_seconds", "max_records_per_round", "max_total_rows", "max_provider_requests", "max_rounds", "expires_at" ], "title": "CheckTerms" }, "ChunkView": { "properties": { "position": { "type": "integer", "title": "Position" }, "first_row": { "type": "integer", "title": "First Row" }, "rows": { "type": "integer", "title": "Rows" }, "valid_rows": { "type": "integer", "title": "Valid Rows" }, "invalid_rows": { "type": "integer", "title": "Invalid Rows" }, "bytes": { "type": "integer", "title": "Bytes" }, "sha256": { "type": "string", "title": "Sha256" }, "digest": { "type": "string", "title": "Digest" } }, "type": "object", "required": [ "position", "first_row", "rows", "valid_rows", "invalid_rows", "bytes", "sha256", "digest" ], "title": "ChunkView" }, "CompanyAvailability": { "properties": {}, "additionalProperties": false, "type": "object", "title": "CompanyAvailability" }, "CompanyData": { "properties": { "COMPANY_ID": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company ID" }, "COMPANY_NAME": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company name" }, "COMPANY_DOMAIN": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company domain" }, "COMPANY_CITY": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company city" }, "COMPANY_STATE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company state" }, "COMPANY_COUNTRY": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company country" }, "COMPANY_LOGO_URL": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company logo URL" } }, "additionalProperties": false, "type": "object", "title": "CompanyData" }, "CompanyEdit": { "properties": { "expected_revision": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Expected Revision" }, "state": { "anyOf": [ { "type": "string", "enum": [ "active", "archived" ] }, { "type": "null" } ], "title": "State" }, "COMPANY_ID": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company ID" }, "COMPANY_NAME": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company name" }, "COMPANY_DOMAIN": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company domain" }, "COMPANY_CITY": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company city" }, "COMPANY_STATE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company state" }, "COMPANY_COUNTRY": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company country" }, "COMPANY_LOGO_URL": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company logo URL" }, "remove_overrides": { "items": { "type": "string", "enum": [ "COMPANY_NAME", "COMPANY_DOMAIN", "COMPANY_CITY", "COMPANY_STATE", "COMPANY_COUNTRY", "COMPANY_LOGO_URL" ] }, "type": "array", "maxItems": 64, "minItems": 1, "title": "Remove Overrides", "description": "Remove selected provided overrides and use the selected owned snapshot values. Requires a catalogue-backed licensed record; omission preserves overrides, null still masks a value. No purchase or source refresh." } }, "additionalProperties": false, "type": "object", "required": [ "expected_revision" ], "title": "CompanyEdit" }, "CompanyPreview": { "properties": { "COMPANY_ID": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company ID" }, "COMPANY_NAME": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company name" }, "COMPANY_DOMAIN": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company domain" }, "COMPANY_CITY": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company city" }, "COMPANY_STATE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company state" }, "COMPANY_COUNTRY": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company country" }, "COMPANY_LOGO_URL": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company logo URL" } }, "additionalProperties": false, "type": "object", "title": "CompanyPreview" }, "CompanyView": { "properties": { "id": { "type": "string", "title": "Id" }, "revision": { "type": "integer", "title": "Revision" }, "state": { "type": "string", "enum": [ "active", "archived" ], "title": "State" }, "source": { "type": "string", "enum": [ "manual", "catalogue" ], "title": "Source", "default": "manual" }, "source_state": { "anyOf": [ { "$ref": "#/components/schemas/SourceState" }, { "type": "null" } ] }, "data_access": { "type": "string", "enum": [ "user_provided", "preview_only", "licensed" ], "title": "Data Access", "default": "user_provided" }, "owned_snapshot": { "anyOf": [ { "$ref": "#/components/schemas/OwnedData" }, { "type": "null" } ] }, "created_at": { "type": "string", "title": "Created At" }, "updated_at": { "type": "string", "title": "Updated At" }, "fields": { "$ref": "#/components/schemas/CompanyData" }, "overridden_fields": { "items": { "type": "string", "enum": [ "COMPANY_ID", "COMPANY_NAME", "COMPANY_DOMAIN", "COMPANY_CITY", "COMPANY_STATE", "COMPANY_COUNTRY", "COMPANY_LOGO_URL" ] }, "type": "array", "maxItems": 64, "title": "Overridden Fields", "description": "Explicit manual overrides present in fields, including nulls; empty for manual records." } }, "type": "object", "required": [ "id", "revision", "state", "created_at", "updated_at", "fields", "overridden_fields" ], "title": "CompanyView" }, "ComplianceStatus": { "properties": { "configured": { "type": "boolean", "title": "Configured" }, "profile": { "anyOf": [ { "$ref": "#/components/schemas/SenderProfile" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "required": [ "configured", "profile" ], "title": "ComplianceStatus" }, "Confirmation": { "properties": { "revision": { "type": "integer", "minimum": 0.0, "title": "Revision" }, "maximum_cents": { "type": "integer", "minimum": 0.0, "title": "Maximum Cents" }, "policy": { "type": "string", "maxLength": 64, "title": "Policy" }, "provisioning_policy": { "anyOf": [ { "type": "string", "const": "inboxkit-provisioning-v1" }, { "type": "null" } ], "title": "Provisioning Policy" } }, "additionalProperties": false, "type": "object", "required": [ "revision", "maximum_cents", "policy" ], "title": "Confirmation" }, "Contact": { "properties": { "email": { "type": "string", "maxLength": 254, "title": "Email" }, "fields": { "additionalProperties": { "type": "string" }, "type": "object", "maxProperties": 256, "title": "Fields" } }, "additionalProperties": false, "type": "object", "required": [ "email" ], "title": "Contact" }, "ContactCampaign": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "state": { "type": "string", "title": "State" }, "archived": { "type": "boolean", "title": "Archived" }, "admitted": { "type": "boolean", "title": "Admitted", "description": "This workspace Contact has an original campaign admission. Does not imply a send." }, "contacted": { "type": "boolean", "title": "Contacted", "description": "At least one campaign sequence submission was accepted. Not confirmed delivery; excludes manual replies and unlinked historical recipients." }, "submitted_count": { "type": "integer", "title": "Submitted Count" }, "last_submission_recorded_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Submission Recorded At" }, "unknown_submission_count": { "type": "integer", "title": "Unknown Submission Count", "description": "Unresolved sequence submission outcomes; zero accepted sends with unknown outcomes must not be labelled never contacted." }, "lists": { "items": { "$ref": "#/components/schemas/CampaignListMembership" }, "type": "array", "maxItems": 50, "title": "Lists", "description": "Current Contact memberships in Lists still connected to this campaign, including archived Lists. Connections do not imply admission or sending authority." }, "eligibility": { "anyOf": [ { "$ref": "#/components/schemas/RecipientEligibility" }, { "type": "null" } ], "description": "Current campaign qualification for an admitted recipient. Null means not admitted or unavailable, never eligible by inference." } }, "type": "object", "required": [ "id", "name", "state", "archived", "admitted", "contacted", "submitted_count", "last_submission_recorded_at", "unknown_submission_count", "lists" ], "title": "ContactCampaign" }, "ContactsIn": { "properties": { "operation_id": { "anyOf": [ { "type": "string", "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._~-]*$" }, { "type": "null" } ], "title": "Operation Id" }, "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" }, "ConversationArchive": { "properties": { "seq": { "type": "integer", "title": "Seq" }, "id": { "type": "string", "title": "Id" }, "actor": { "type": "string", "title": "Actor" }, "revision": { "type": "integer", "title": "Revision" }, "created_at": { "type": "number", "title": "Created At" }, "kind": { "type": "string", "const": "conversation", "title": "Kind" }, "resource": { "type": "string", "title": "Resource" }, "archived": { "type": "integer", "enum": [ 0, 1 ], "title": "Archived" } }, "additionalProperties": false, "type": "object", "required": [ "seq", "id", "actor", "revision", "created_at", "kind", "resource", "archived" ], "title": "ConversationArchive" }, "ConversationAssignment": { "properties": { "seq": { "type": "integer", "title": "Seq" }, "id": { "type": "string", "title": "Id" }, "actor": { "type": "string", "title": "Actor" }, "revision": { "type": "integer", "title": "Revision" }, "created_at": { "type": "number", "title": "Created At" }, "conversation": { "type": "string", "title": "Conversation" }, "previous_assignee": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous Assignee" }, "assignee": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Assignee" } }, "additionalProperties": false, "type": "object", "required": [ "seq", "id", "actor", "revision", "created_at", "conversation", "previous_assignee", "assignee" ], "title": "ConversationAssignment" }, "ConversationChange": { "properties": { "seq": { "type": "integer", "title": "Seq" }, "id": { "type": "string", "title": "Id" }, "actor": { "type": "string", "title": "Actor" }, "revision": { "type": "integer", "title": "Revision" }, "created_at": { "type": "number", "title": "Created At" }, "conversation": { "type": "string", "title": "Conversation" }, "previous_status": { "type": "string", "enum": [ "needs_reply", "waiting", "closed" ], "title": "Previous Status" }, "status": { "type": "string", "enum": [ "needs_reply", "waiting", "closed" ], "title": "Status" } }, "additionalProperties": false, "type": "object", "required": [ "seq", "id", "actor", "revision", "created_at", "conversation", "previous_status", "status" ], "title": "ConversationChange" }, "ConversationDetail": { "properties": { "conversation": { "$ref": "#/components/schemas/ConversationDetailRecord" }, "followups": { "$ref": "#/components/schemas/ConversationFollowups" }, "read_by": { "items": { "$ref": "#/components/schemas/ConversationReader" }, "type": "array", "maxItems": 20, "title": "Read By" }, "read_by_more": { "type": "boolean", "title": "Read By More" }, "items": { "items": { "anyOf": [ { "$ref": "#/components/schemas/InboundMessage" }, { "$ref": "#/components/schemas/UnavailableInboundMessage" }, { "$ref": "#/components/schemas/OutboundMessage" }, { "$ref": "#/components/schemas/UnavailableOutboundMessage" } ] }, "type": "array", "maxItems": 200, "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Next Cursor" } }, "additionalProperties": false, "type": "object", "required": [ "conversation", "followups", "read_by", "read_by_more", "items", "next_cursor" ], "title": "ConversationDetail" }, "ConversationDetailRecord": { "properties": { "workspace": { "type": "string", "title": "Workspace" }, "id": { "type": "string", "title": "Id" }, "last_activity": { "type": "number", "title": "Last Activity" }, "last_inbound_seq": { "type": "integer", "title": "Last Inbound Seq" }, "status": { "type": "string", "enum": [ "needs_reply", "waiting", "closed" ], "title": "Status" }, "revision": { "type": "integer", "title": "Revision" }, "assignee": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Assignee" }, "archived": { "type": "integer", "enum": [ 0, 1 ], "title": "Archived" }, "has_sent": { "type": "integer", "enum": [ 0, 1 ], "title": "Has Sent" }, "email": { "type": "string", "title": "Email" }, "campaign": { "type": "string", "title": "Campaign" }, "attention_seq": { "type": "integer", "title": "Attention Seq" }, "handoff": { "anyOf": [ { "$ref": "#/components/schemas/ConversationHandoff" }, { "type": "null" } ] }, "inbox": { "$ref": "#/components/schemas/ConversationInbox" }, "unread": { "type": "integer", "enum": [ 0, 1 ], "title": "Unread" } }, "additionalProperties": false, "type": "object", "required": [ "workspace", "id", "last_activity", "last_inbound_seq", "status", "revision", "assignee", "archived", "has_sent", "email", "campaign", "attention_seq", "handoff", "inbox", "unread" ], "title": "ConversationDetailRecord" }, "ConversationDoNotContact": { "properties": { "id": { "type": "string", "title": "Id" }, "event_id": { "type": "string", "title": "Event Id" }, "intent": { "type": "string", "const": "opt_out", "title": "Intent" }, "reply_revision": { "type": "integer", "title": "Reply Revision" }, "status": { "type": "string", "const": "closed", "title": "Status" }, "conversation_revision": { "type": "integer", "title": "Conversation Revision" }, "replayed": { "type": "boolean", "title": "Replayed" } }, "additionalProperties": false, "type": "object", "required": [ "id", "event_id", "intent", "reply_revision", "status", "conversation_revision", "replayed" ], "title": "ConversationDoNotContact" }, "ConversationFollowups": { "properties": { "state": { "type": "string", "enum": [ "stopped", "inactive", "in_progress", "held", "paused", "queued", "preparing", "waiting" ], "title": "State" }, "next_eligible_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Next Eligible At" }, "step": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Step" }, "stop_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stop Id" }, "stopped_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Stopped At" }, "can_stop": { "type": "boolean", "title": "Can Stop" } }, "additionalProperties": false, "type": "object", "required": [ "state", "next_eligible_at", "step", "stop_id", "stopped_at", "can_stop" ], "title": "ConversationFollowups" }, "ConversationHandoff": { "properties": { "job_id": { "type": "string", "title": "Job Id" }, "state": { "type": "string", "enum": [ "queued", "reserved", "dispatching", "accepted", "not_accepted", "unknown", "cancelled" ], "title": "State" }, "snapshot": { "$ref": "#/components/schemas/HandoffSnapshot" }, "resumed_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Resumed At" } }, "additionalProperties": false, "type": "object", "required": [ "job_id", "state", "snapshot", "resumed_at" ], "title": "ConversationHandoff" }, "ConversationHistory_ConversationArchive_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ConversationArchive" }, "type": "array", "maxItems": 200, "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Next Cursor" } }, "additionalProperties": false, "type": "object", "required": [ "items", "next_cursor" ], "title": "ConversationHistory[ConversationArchive]" }, "ConversationHistory_ConversationAssignment_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ConversationAssignment" }, "type": "array", "maxItems": 200, "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Next Cursor" } }, "additionalProperties": false, "type": "object", "required": [ "items", "next_cursor" ], "title": "ConversationHistory[ConversationAssignment]" }, "ConversationHistory_ConversationChange_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ConversationChange" }, "type": "array", "maxItems": 200, "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Next Cursor" } }, "additionalProperties": false, "type": "object", "required": [ "items", "next_cursor" ], "title": "ConversationHistory[ConversationChange]" }, "ConversationHistory_ConversationNote_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ConversationNote" }, "type": "array", "maxItems": 200, "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Next Cursor" } }, "additionalProperties": false, "type": "object", "required": [ "items", "next_cursor" ], "title": "ConversationHistory[ConversationNote]" }, "ConversationInbox": { "properties": { "workflow": { "type": "string", "enum": [ "needs_reply", "waiting", "closed", "unknown" ], "title": "Workflow" }, "reply_delivery": { "type": "string", "enum": [ "queued", "sending", "unconfirmed", "failed", "accepted", "none", "unknown" ], "title": "Reply Delivery" }, "intent": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Intent" }, "classification_state": { "type": "string", "enum": [ "pending", "leased", "suggested", "applied", "failed", "unknown" ], "title": "Classification State" } }, "additionalProperties": false, "type": "object", "required": [ "workflow", "reply_delivery", "intent" ], "title": "ConversationInbox" }, "ConversationListItem": { "properties": { "workspace": { "type": "string", "title": "Workspace" }, "id": { "type": "string", "title": "Id" }, "last_activity": { "type": "number", "title": "Last Activity" }, "last_inbound_seq": { "type": "integer", "title": "Last Inbound Seq" }, "status": { "type": "string", "enum": [ "needs_reply", "waiting", "closed" ], "title": "Status" }, "revision": { "type": "integer", "title": "Revision" }, "assignee": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Assignee" }, "archived": { "type": "integer", "enum": [ 0, 1 ], "title": "Archived" }, "has_sent": { "type": "integer", "enum": [ 0, 1 ], "title": "Has Sent" }, "email": { "type": "string", "title": "Email" }, "campaign": { "type": "string", "title": "Campaign" }, "attention_seq": { "type": "integer", "title": "Attention Seq" }, "handoff": { "anyOf": [ { "$ref": "#/components/schemas/ConversationHandoff" }, { "type": "null" } ] }, "inbox": { "$ref": "#/components/schemas/ConversationInbox" }, "campaign_name": { "type": "string", "title": "Campaign Name" }, "unread": { "type": "integer", "enum": [ 0, 1 ], "title": "Unread" } }, "additionalProperties": false, "type": "object", "required": [ "workspace", "id", "last_activity", "last_inbound_seq", "status", "revision", "assignee", "archived", "has_sent", "email", "campaign", "attention_seq", "handoff", "inbox", "campaign_name", "unread" ], "title": "ConversationListItem" }, "ConversationNote": { "properties": { "seq": { "type": "integer", "title": "Seq" }, "id": { "type": "string", "title": "Id" }, "actor": { "type": "string", "title": "Actor" }, "revision": { "type": "integer", "title": "Revision" }, "created_at": { "type": "number", "title": "Created At" }, "conversation": { "type": "string", "title": "Conversation" }, "body": { "type": "string", "title": "Body" } }, "additionalProperties": false, "type": "object", "required": [ "seq", "id", "actor", "revision", "created_at", "conversation", "body" ], "title": "ConversationNote" }, "ConversationPage": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ConversationListItem" }, "type": "array", "maxItems": 200, "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor", "description": "Continue with the same filters; bounded search/intent/attention windows may return fewer items or an empty page with a cursor." } }, "additionalProperties": false, "type": "object", "required": [ "items", "next_cursor" ], "title": "ConversationPage" }, "ConversationRead": { "properties": { "recorded": { "type": "boolean", "const": true, "title": "Recorded" } }, "additionalProperties": false, "type": "object", "required": [ "recorded" ], "title": "ConversationRead" }, "ConversationReader": { "properties": { "user_id": { "type": "string", "title": "User Id" }, "email": { "type": "string", "title": "Email" }, "read_at": { "type": "number", "title": "Read At" } }, "additionalProperties": false, "type": "object", "required": [ "user_id", "email", "read_at" ], "title": "ConversationReader" }, "ConversationStop": { "properties": { "id": { "type": "string", "title": "Id" }, "conversation": { "type": "string", "title": "Conversation" }, "conversation_revision": { "type": "integer", "title": "Conversation Revision" }, "stopped_at": { "type": "number", "title": "Stopped At" }, "replayed": { "type": "boolean", "title": "Replayed" } }, "additionalProperties": false, "type": "object", "required": [ "id", "conversation", "conversation_revision", "stopped_at", "replayed" ], "title": "ConversationStop" }, "CopyChangeReceipt": { "properties": { "id": { "type": "string", "title": "Id" }, "campaign": { "type": "string", "title": "Campaign" }, "revision": { "type": "integer", "minimum": 1.0, "title": "Revision", "description": "Campaign revision accepted by this original, not the current campaign revision." }, "phase": { "type": "string", "enum": [ "preparations", "complete" ], "title": "Phase", "description": "Bounded route and pending-work invalidation, not copy generation." }, "processed": { "type": "integer", "minimum": 0.0, "title": "Processed", "description": "Pending jobs/preparations and route rows examined. Not unique recipients, changed rows or a total." }, "created_at": { "type": "number", "title": "Created At", "description": "Original acceptance time, Unix seconds." }, "completed_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Completed At", "description": "Invalidation completion time, Unix seconds; null while pending. Does not establish copy readiness." }, "completion_semantics": { "type": "string", "const": "invalidation_complete_not_all_copy_ready", "title": "Completion Semantics" } }, "additionalProperties": false, "type": "object", "required": [ "id", "campaign", "revision", "phase", "processed", "created_at", "completed_at", "completion_semantics" ], "title": "CopyChangeReceipt", "examples": [ { "campaign": "example-campaign", "completion_semantics": "invalidation_complete_not_all_copy_ready", "created_at": 1791590400.0, "id": "copy-edit", "phase": "preparations", "processed": 100, "revision": 4 }, { "campaign": "example-campaign", "completed_at": 1791590402.0, "completion_semantics": "invalidation_complete_not_all_copy_ready", "created_at": 1791590400.0, "id": "copy-edit", "phase": "complete", "processed": 125, "revision": 4 } ] }, "CopyPolicy": { "properties": { "transformer": { "type": "string", "title": "Transformer" }, "variants_enabled": { "type": "boolean", "title": "Variants Enabled" }, "brace_syntax": { "type": "boolean", "title": "Brace Syntax" }, "adds_business_footer": { "type": "boolean", "title": "Adds Business Footer" }, "quality_check": { "type": "string", "title": "Quality Check", "default": "not_model_reviewed" }, "provider_cost_usd_micros": { "type": "integer", "title": "Provider Cost Usd Micros", "default": 0 }, "template_formats": { "items": { "type": "integer" }, "type": "array", "title": "Template Formats" }, "required_body_variables": { "items": { "type": "string" }, "type": "array", "title": "Required Body Variables" } }, "type": "object", "required": [ "transformer", "variants_enabled", "brace_syntax", "adds_business_footer" ], "title": "CopyPolicy" }, "CopyPreview": { "properties": { "content": { "$ref": "#/components/schemas/PreviewCopy" }, "transformer": { "type": "string", "title": "Transformer" }, "subject_state": { "type": "string", "enum": [ "authored", "inherited", "pending_predecessor" ], "title": "Subject State" }, "quality_check": { "type": "string", "title": "Quality Check", "default": "not_model_reviewed" }, "provider_cost_usd_micros": { "type": "integer", "title": "Provider Cost Usd Micros", "default": 0 }, "sender_bound": { "type": "boolean", "title": "Sender Bound", "default": false }, "preview_sender": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Preview Sender" }, "profile_scope": { "type": "string", "title": "Profile Scope", "default": "workspace_default" } }, "type": "object", "required": [ "content", "transformer", "subject_state" ], "title": "CopyPreview" }, "CopyPreviewIn": { "properties": { "template_format": { "type": "integer", "maximum": 2.0, "minimum": 1.0, "title": "Template Format", "default": 1 }, "campaign": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Campaign" }, "recipient": { "type": "string", "maxLength": 320, "minLength": 1, "title": "Recipient" }, "fields": { "additionalProperties": { "type": "string" }, "type": "object", "maxProperties": 256, "title": "Fields" }, "subject": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Subject" }, "body": { "type": "string", "maxLength": 100000, "minLength": 1, "title": "Body" }, "step": { "type": "integer", "minimum": 0.0, "title": "Step" }, "variation": { "type": "integer", "maximum": 999999.0, "minimum": 0.0, "title": "Variation" }, "sender_mailbox": { "anyOf": [ { "type": "string", "maxLength": 320 }, { "type": "null" } ], "title": "Sender Mailbox" } }, "additionalProperties": false, "type": "object", "required": [ "campaign", "recipient", "body", "step", "variation" ], "title": "CopyPreviewIn" }, "CurrentCampaignStart": { "properties": { "operation": { "anyOf": [ { "$ref": "#/components/schemas/CampaignStartResponse" }, { "type": "null" } ] }, "window_opens_at": { "type": "number", "title": "Window Opens At" } }, "additionalProperties": false, "type": "object", "required": [ "operation", "window_opens_at" ], "title": "CurrentCampaignStart" }, "CurrentCapacity": { "properties": { "billing_model": { "type": "string", "const": "subscription-30d-v1", "title": "Billing Model" }, "mode": { "type": "string", "const": "funded", "title": "Mode" }, "operation": { "anyOf": [ { "$ref": "#/components/schemas/CapacityOperation" }, { "type": "null" } ] }, "timeline": { "$ref": "#/components/schemas/CapacityTimeline" }, "desired_capacity": { "$ref": "#/components/schemas/CapacityMandate" }, "attention": { "$ref": "#/components/schemas/CapacityAttention" } }, "additionalProperties": false, "type": "object", "required": [ "billing_model", "mode", "operation", "timeline", "desired_capacity", "attention" ], "title": "CurrentCapacity" }, "CurrentVerificationBatch": { "properties": { "batch": { "anyOf": [ { "$ref": "#/components/schemas/VerificationBatchView" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "required": [ "batch" ], "title": "CurrentVerificationBatch" }, "DailyDeliveryCounts": { "properties": { "dispatch_started": { "type": "integer", "minimum": 0.0, "title": "Dispatch Started" }, "accepted": { "type": "integer", "minimum": 0.0, "title": "Accepted" }, "declined": { "type": "integer", "minimum": 0.0, "title": "Declined" }, "unknown": { "type": "integer", "minimum": 0.0, "title": "Unknown" }, "pending": { "type": "integer", "minimum": 0.0, "title": "Pending" }, "reported_failed": { "type": "integer", "minimum": 0.0, "title": "Reported Failed" }, "delivery_delayed": { "type": "integer", "minimum": 0.0, "title": "Delivery Delayed" } }, "additionalProperties": false, "type": "object", "required": [ "dispatch_started", "accepted", "declined", "unknown", "pending", "reported_failed", "delivery_delayed" ], "title": "DailyDeliveryCounts" }, "DailyDeliveryDay": { "properties": { "date": { "type": "string", "title": "Date" }, "start": { "type": "number", "title": "Start" }, "end": { "type": "number", "title": "End" }, "counts": { "$ref": "#/components/schemas/DailyDeliveryLanes" } }, "additionalProperties": false, "type": "object", "required": [ "date", "start", "end", "counts" ], "title": "DailyDeliveryDay" }, "DailyDeliveryDays": { "properties": { "definition": { "type": "string", "const": "dispatch-cohort-daily-v1", "title": "Definition" }, "observed_at": { "type": "number", "title": "Observed At" }, "timezone": { "type": "string", "title": "Timezone" }, "campaign_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Campaign Id" }, "window": { "$ref": "#/components/schemas/DeliveryWindow" }, "days": { "items": { "$ref": "#/components/schemas/DailyDeliveryDay" }, "type": "array", "title": "Days" } }, "additionalProperties": false, "type": "object", "required": [ "definition", "observed_at", "timezone", "campaign_id", "window", "days" ], "title": "DailyDeliveryDays" }, "DailyDeliveryLanes": { "properties": { "campaign": { "$ref": "#/components/schemas/DailyDeliveryCounts" }, "reply": { "$ref": "#/components/schemas/DailyDeliveryCounts" } }, "additionalProperties": false, "type": "object", "required": [ "campaign", "reply" ], "title": "DailyDeliveryLanes" }, "DataBalance": { "properties": { "currency": { "type": "string", "const": "usd", "title": "Currency", "default": "usd" }, "available_minor": { "type": "integer", "title": "Available Minor" }, "promotional_minor": { "type": "integer", "title": "Promotional Minor", "default": 0 }, "debt_minor": { "type": "integer", "title": "Debt Minor", "default": 0 }, "purchase_blocked": { "type": "boolean", "title": "Purchase Blocked", "default": false }, "signup_bonus": { "$ref": "#/components/schemas/SignupBonus" } }, "type": "object", "required": [ "available_minor" ], "title": "DataBalance" }, "DataCapabilities": { "properties": { "purchases_enabled": { "type": "boolean", "title": "Purchases Enabled" }, "policies": { "items": { "$ref": "#/components/schemas/DataPolicy" }, "type": "array", "title": "Policies" }, "field_schemas": { "items": { "$ref": "#/components/schemas/DataFieldSchema" }, "type": "array", "title": "Field Schemas" }, "max_direct_items": { "type": "integer", "title": "Max Direct Items", "default": 100 }, "enrichment_enabled": { "type": "boolean", "title": "Enrichment Enabled", "default": false }, "funding_enabled": { "type": "boolean", "title": "Funding Enabled", "default": false }, "auto_funding_enabled": { "type": "boolean", "title": "Auto Funding Enabled", "default": false }, "bulk_enabled": { "type": "boolean", "title": "Bulk Enabled", "default": false }, "review_confirmation_enabled": { "type": "boolean", "title": "Review Confirmation Enabled", "default": true }, "review_confirmation_max_rows": { "type": "integer", "title": "Review Confirmation Max Rows", "default": 100 }, "review_job_confirmation_enabled": { "type": "boolean", "title": "Review Job Confirmation Enabled", "default": true }, "review_job_chunk_rows": { "type": "integer", "title": "Review Job Chunk Rows", "default": 25 }, "review_confirmation_max_bytes": { "type": "integer", "title": "Review Confirmation Max Bytes", "default": 1048576 }, "review_paid_confirmation_enabled": { "type": "boolean", "title": "Review Paid Confirmation Enabled", "default": false }, "exports_enabled": { "type": "boolean", "title": "Exports Enabled", "default": true }, "export_formats": { "items": { "type": "string", "enum": [ "csv", "json", "jsonl", "xlsx" ] }, "type": "array", "title": "Export Formats" }, "export_max_rows": { "type": "integer", "title": "Export Max Rows", "default": 100 }, "export_max_bytes": { "type": "integer", "title": "Export Max Bytes", "default": 1048576 }, "export_retention_seconds": { "type": "integer", "title": "Export Retention Seconds", "default": 86400 }, "export_workspace_artifacts": { "type": "integer", "title": "Export Workspace Artifacts", "default": 8 }, "export_global_artifacts": { "type": "integer", "title": "Export Global Artifacts", "default": 64 } }, "type": "object", "required": [ "purchases_enabled", "policies", "field_schemas" ], "title": "DataCapabilities" }, "DataFieldSchema": { "properties": { "entity_type": { "type": "string", "enum": [ "person", "company" ], "title": "Entity Type" }, "effective": { "items": { "type": "string" }, "type": "array", "title": "Effective", "description": "Editable record fields and allowed effective export projection." }, "licensed": { "items": { "type": "string" }, "type": "array", "title": "Licensed", "description": "Owned snapshot fields and allowed licensed export projection; availability is not ownership." }, "defaults": { "items": { "type": "string" }, "type": "array", "title": "Defaults", "description": "Ordered default export fields from the approved dataset registry." } }, "type": "object", "required": [ "entity_type", "effective", "licensed", "defaults" ], "title": "DataFieldSchema" }, "DataPolicy": { "properties": { "id": { "type": "string", "maxLength": 100, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "title": "Id" }, "entity_type": { "type": "string", "enum": [ "person", "company" ], "title": "Entity Type" }, "currency": { "type": "string", "const": "usd", "title": "Currency", "default": "usd" }, "unit_amount_minor": { "type": "integer", "maximum": 100000.0, "minimum": 0.0, "title": "Unit Amount Minor" } }, "additionalProperties": false, "type": "object", "required": [ "id", "entity_type", "unit_amount_minor" ], "title": "DataPolicy" }, "DataUsage": { "properties": { "currency": { "type": "string", "const": "usd", "title": "Currency", "default": "usd" }, "available_minor": { "type": "integer", "title": "Available Minor" }, "promotional_minor": { "type": "integer", "title": "Promotional Minor", "default": 0 }, "debt_minor": { "type": "integer", "title": "Debt Minor", "default": 0 }, "purchase_blocked": { "type": "boolean", "title": "Purchase Blocked", "default": false }, "signup_bonus": { "$ref": "#/components/schemas/SignupBonus" }, "period": { "type": "string", "title": "Period" }, "automatic_exposure_minor": { "type": "integer", "title": "Automatic Exposure Minor" }, "items": { "items": { "$ref": "#/components/schemas/LedgerItem" }, "type": "array", "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "additionalProperties": false, "type": "object", "required": [ "available_minor", "period", "automatic_exposure_minor", "items" ], "title": "DataUsage" }, "DefaultCard": { "properties": { "id": { "type": "string", "maxLength": 128, "minLength": 1, "pattern": "^[^_].*$", "title": "Id" }, "revision": { "type": "integer", "minimum": 0.0, "title": "Revision" }, "method": { "type": "string", "maxLength": 128, "pattern": "^pm_[A-Za-z0-9]+$", "title": "Method" } }, "additionalProperties": false, "type": "object", "required": [ "id", "revision", "method" ], "title": "DefaultCard" }, "DeliveredRow": { "properties": { "ordinal": { "type": "integer", "title": "Ordinal" }, "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Key" }, "record_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Record Id" }, "version_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version Id" }, "grant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Grant Id" }, "outcome": { "type": "string", "enum": [ "owned", "provided", "preview", "excluded" ], "title": "Outcome" }, "fields": { "anyOf": [ { "additionalProperties": { "$ref": "#/components/schemas/JsonValue" }, "type": "object" }, { "type": "null" } ], "title": "Fields", "description": "Original delivered projection, not a request for new fields. Historical keys are preserved without conversion." }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" } }, "additionalProperties": false, "type": "object", "required": [ "ordinal", "key", "record_id", "version_id", "grant_id", "outcome", "fields", "reason" ], "title": "DeliveredRow" }, "DeliveryCoverage": { "properties": { "placement": { "type": "string", "const": "not_measured", "title": "Placement" }, "recipient_delivery": { "type": "string", "const": "not_confirmed", "title": "Recipient Delivery" }, "dsn": { "type": "string", "const": "correlated_reports_and_receiver_attested_subset", "title": "Dsn" }, "dispatch": { "type": "string", "const": "recorded_intents_not_proven_submission", "title": "Dispatch" }, "history": { "type": "string", "const": "not_backfilled", "title": "History" }, "reply_labels": { "type": "string", "const": "current_triage", "title": "Reply Labels" } }, "additionalProperties": false, "type": "object", "required": [ "placement", "recipient_delivery", "dsn", "dispatch", "history", "reply_labels" ], "title": "DeliveryCoverage" }, "DeliveryDispatchCounts": { "properties": { "dispatch_started": { "type": "integer", "minimum": 0.0, "title": "Dispatch Started" }, "accepted": { "type": "integer", "minimum": 0.0, "title": "Accepted" }, "declined": { "type": "integer", "minimum": 0.0, "title": "Declined" }, "unknown": { "type": "integer", "minimum": 0.0, "title": "Unknown" }, "pending": { "type": "integer", "minimum": 0.0, "title": "Pending" }, "dispatch_acceptance_rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Dispatch Acceptance Rate" } }, "additionalProperties": false, "type": "object", "required": [ "dispatch_started", "accepted", "declined", "unknown", "pending", "dispatch_acceptance_rate" ], "title": "DeliveryDispatchCounts" }, "DeliveryDispatchLanes": { "properties": { "campaign": { "$ref": "#/components/schemas/DeliveryDispatchCounts" }, "reply": { "$ref": "#/components/schemas/DeliveryDispatchCounts" } }, "additionalProperties": false, "type": "object", "required": [ "campaign", "reply" ], "title": "DeliveryDispatchLanes" }, "DeliveryEngagement": { "properties": { "accepted_first_touches": { "type": "integer", "minimum": 0.0, "title": "Accepted First Touches" }, "replied": { "type": "integer", "minimum": 0.0, "title": "Replied" }, "out_of_office_replies": { "type": "integer", "minimum": 0.0, "title": "Out Of Office Replies" }, "human_replied": { "type": "integer", "minimum": 0.0, "title": "Human Replied" }, "unclassified_replies": { "type": "integer", "minimum": 0.0, "title": "Unclassified Replies" }, "reported_failed_first_touches": { "type": "integer", "minimum": 0.0, "title": "Reported Failed First Touches" }, "human_reply_rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Human Reply Rate" }, "reply_rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Reply Rate" }, "reported_failure_rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Reported Failure Rate" } }, "additionalProperties": false, "type": "object", "required": [ "accepted_first_touches", "replied", "out_of_office_replies", "human_replied", "unclassified_replies", "reported_failed_first_touches", "human_reply_rate", "reply_rate", "reported_failure_rate" ], "title": "DeliveryEngagement" }, "DeliveryEvidence": { "properties": { "accepted_messages": { "type": "integer", "minimum": 0.0, "title": "Accepted Messages" }, "reported_failed_messages": { "type": "integer", "minimum": 0.0, "title": "Reported Failed Messages" }, "delayed_messages": { "type": "integer", "minimum": 0.0, "title": "Delayed Messages" }, "reported_failure_rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Reported Failure Rate" }, "lanes": { "$ref": "#/components/schemas/DeliveryEvidenceLanes" }, "no_reported_failure_messages": { "type": "integer", "minimum": 0.0, "title": "No Reported Failure Messages" }, "no_reported_failure_rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "No Reported Failure Rate" } }, "additionalProperties": false, "type": "object", "required": [ "accepted_messages", "reported_failed_messages", "delayed_messages", "reported_failure_rate", "lanes", "no_reported_failure_messages", "no_reported_failure_rate" ], "title": "DeliveryEvidence" }, "DeliveryEvidenceLanes": { "properties": { "first_touch": { "$ref": "#/components/schemas/DeliveryLaneEvidence" }, "follow_up": { "$ref": "#/components/schemas/DeliveryLaneEvidence" }, "reply": { "$ref": "#/components/schemas/DeliveryLaneEvidence" } }, "additionalProperties": false, "type": "object", "required": [ "first_touch", "follow_up", "reply" ], "title": "DeliveryEvidenceLanes" }, "DeliveryLaneEvidence": { "properties": { "accepted_messages": { "type": "integer", "minimum": 0.0, "title": "Accepted Messages" }, "reported_failed_messages": { "type": "integer", "minimum": 0.0, "title": "Reported Failed Messages" }, "delayed_messages": { "type": "integer", "minimum": 0.0, "title": "Delayed Messages" }, "reported_failure_rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Reported Failure Rate" } }, "additionalProperties": false, "type": "object", "required": [ "accepted_messages", "reported_failed_messages", "delayed_messages", "reported_failure_rate" ], "title": "DeliveryLaneEvidence" }, "DeliveryReportedOutcome": { "properties": { "action": { "type": "string", "title": "Action" }, "status": { "type": "string", "title": "Status" }, "accepted_jobs": { "type": "integer", "minimum": 0.0, "title": "Accepted Jobs" } }, "additionalProperties": false, "type": "object", "required": [ "action", "status", "accepted_jobs" ], "title": "DeliveryReportedOutcome" }, "DeliverySummary": { "properties": { "definition_version": { "type": "string", "const": "delivery-v2", "title": "Definition Version" }, "window": { "$ref": "#/components/schemas/DeliveryWindow" }, "observed_at": { "type": "number", "title": "Observed At" }, "campaign_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Campaign Id" }, "counts": { "$ref": "#/components/schemas/DeliveryDispatchLanes" }, "engagement": { "$ref": "#/components/schemas/DeliveryEngagement" }, "delivery_evidence": { "$ref": "#/components/schemas/DeliveryEvidence" }, "reported_outcomes": { "items": { "$ref": "#/components/schemas/DeliveryReportedOutcome" }, "type": "array", "title": "Reported Outcomes" }, "recipient_delivery_rate": { "type": "null", "title": "Recipient Delivery Rate" }, "inbox_placement_rate": { "type": "null", "title": "Inbox Placement Rate" }, "coverage": { "$ref": "#/components/schemas/DeliveryCoverage" }, "definition": { "type": "string", "title": "Definition" } }, "additionalProperties": false, "type": "object", "required": [ "definition_version", "window", "observed_at", "campaign_id", "counts", "engagement", "delivery_evidence", "reported_outcomes", "recipient_delivery_rate", "inbox_placement_rate", "coverage", "definition" ], "title": "DeliverySummary" }, "DeliveryWindow": { "properties": { "start": { "type": "number", "title": "Start" }, "end": { "type": "number", "title": "End" } }, "additionalProperties": false, "type": "object", "required": [ "start", "end" ], "title": "DeliveryWindow" }, "DoNotContactIn": { "properties": { "id": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Id" }, "expected_revision": { "type": "integer", "minimum": 1.0, "title": "Expected Revision" }, "event_id": { "type": "string", "maxLength": 256, "minLength": 1, "title": "Event Id" }, "expected_reply_revision": { "type": "integer", "minimum": 1.0, "title": "Expected Reply Revision" } }, "additionalProperties": false, "type": "object", "required": [ "id", "expected_revision", "event_id", "expected_reply_revision" ], "title": "DoNotContactIn" }, "DomainSetCapabilities": { "properties": { "enabled": { "type": "boolean", "title": "Enabled", "default": true }, "kind": { "type": "string", "const": "company_domain", "title": "Kind", "default": "company_domain" }, "max_upload_rows": { "type": "integer", "title": "Max Upload Rows", "default": 10000 }, "max_upload_bytes": { "type": "integer", "title": "Max Upload Bytes", "default": 4194304 }, "max_query_domains": { "type": "integer", "title": "Max Query Domains", "default": 10000 }, "max_query_bytes": { "type": "integer", "title": "Max Query Bytes", "default": 4194304 }, "max_references": { "type": "integer", "title": "Max References", "default": 2 }, "workspace_retained_sets": { "type": "integer", "title": "Workspace Retained Sets", "default": 25 }, "workspace_retained_bytes": { "type": "integer", "title": "Workspace Retained Bytes", "default": 33554432 }, "installation_retained_bytes": { "type": "integer", "title": "Installation Retained Bytes", "default": 268435456 } }, "type": "object", "title": "DomainSetCapabilities" }, "DomainSetCreate": { "properties": { "name": { "type": "string", "maxLength": 200, "minLength": 1, "pattern": "\\S", "title": "Name" }, "format": { "type": "string", "enum": [ "csv", "lines" ], "title": "Format" }, "content": { "type": "string", "maxLength": 4194304, "minLength": 1, "title": "Content" }, "allow_invalid_rows": { "type": "boolean", "title": "Allow Invalid Rows", "default": false } }, "additionalProperties": false, "type": "object", "required": [ "name", "format", "content" ], "title": "DomainSetCreate" }, "DomainSetEdit": { "properties": { "expected_revision": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Expected Revision" }, "state": { "anyOf": [ { "type": "string", "enum": [ "active", "archived" ] }, { "type": "null" } ], "title": "State" }, "name": { "anyOf": [ { "type": "string", "maxLength": 200, "minLength": 1, "pattern": "\\S" }, { "type": "null" } ], "title": "Name" } }, "additionalProperties": false, "type": "object", "required": [ "expected_revision" ], "title": "DomainSetEdit" }, "DomainSetError": { "properties": { "row": { "type": "integer", "title": "Row" }, "code": { "type": "string", "const": "invalid_domain_identifier", "title": "Code", "default": "invalid_domain_identifier" } }, "type": "object", "required": [ "row" ], "title": "DomainSetError" }, "DomainSetFilters": { "properties": { "include": { "anyOf": [ { "$ref": "#/components/schemas/DomainSetReference" }, { "type": "null" } ] }, "exclude": { "anyOf": [ { "$ref": "#/components/schemas/DomainSetReference" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "title": "DomainSetFilters" }, "DomainSetReference": { "properties": { "id": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Id" }, "digest": { "type": "string", "pattern": "^[a-f0-9]{64}$", "title": "Digest" } }, "additionalProperties": false, "type": "object", "required": [ "id", "digest" ], "title": "DomainSetReference" }, "DomainSetView": { "properties": { "id": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "kind": { "type": "string", "const": "company_domain", "title": "Kind", "default": "company_domain" }, "state": { "type": "string", "enum": [ "active", "archived" ], "title": "State" }, "revision": { "type": "integer", "title": "Revision" }, "digest": { "type": "string", "title": "Digest" }, "domain_count": { "type": "integer", "title": "Domain Count" }, "input_rows": { "type": "integer", "title": "Input Rows" }, "invalid_rows": { "type": "integer", "title": "Invalid Rows" }, "duplicate_rows": { "type": "integer", "title": "Duplicate Rows" }, "payload_bytes": { "type": "integer", "title": "Payload Bytes" }, "sample": { "items": { "type": "string" }, "type": "array", "maxItems": 20, "title": "Sample" }, "errors": { "items": { "$ref": "#/components/schemas/DomainSetError" }, "type": "array", "maxItems": 20, "title": "Errors" }, "created_at": { "type": "string", "title": "Created At" }, "updated_at": { "type": "string", "title": "Updated At" } }, "type": "object", "required": [ "id", "name", "state", "revision", "digest", "domain_count", "input_rows", "invalid_rows", "duplicate_rows", "payload_bytes", "sample", "errors", "created_at", "updated_at" ], "title": "DomainSetView" }, "EducationHistory": { "properties": { "school_name": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "School Name" }, "school_url": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "School Url" }, "school_location": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "School Location" }, "degree_name": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Degree Name" }, "field_of_study": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Field Of Study" }, "start_year": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Start Year" }, "end_year": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "End Year" } }, "additionalProperties": false, "type": "object", "title": "EducationHistory" }, "EffectiveSenderIdentity": { "properties": { "mailbox": { "type": "string", "title": "Mailbox" }, "revision": { "type": "integer", "title": "Revision" }, "full_name": { "type": "string", "title": "Full Name" }, "job_title": { "type": "string", "title": "Job Title" }, "effective_name": { "type": "string", "title": "Effective Name" }, "effective_title": { "type": "string", "title": "Effective Title" }, "source": { "type": "string", "enum": [ "mailbox", "local_part", "default", "mailbox_name" ], "title": "Source" } }, "additionalProperties": false, "type": "object", "required": [ "mailbox", "revision", "full_name", "job_title", "effective_name", "effective_title", "source" ], "title": "EffectiveSenderIdentity" }, "EligibilityCounts": { "properties": { "qualified": { "type": "integer", "title": "Qualified", "default": 0 }, "preparing": { "type": "integer", "title": "Preparing", "default": 0 }, "waiting": { "type": "integer", "title": "Waiting", "default": 0 }, "ineligible": { "type": "integer", "title": "Ineligible", "default": 0 }, "contacted": { "type": "integer", "title": "Contacted", "default": 0 }, "stopped": { "type": "integer", "title": "Stopped", "default": 0 }, "needs_review": { "type": "integer", "title": "Needs Review", "default": 0 } }, "additionalProperties": false, "type": "object", "title": "EligibilityCounts" }, "EmploymentComparison": { "properties": { "JOB_TITLE": { "type": "string", "enum": [ "unchanged", "changed", "became_available", "became_unavailable", "unavailable" ], "title": "Job Title" }, "COMPANY_NAME": { "type": "string", "enum": [ "unchanged", "changed", "became_available", "became_unavailable", "unavailable" ], "title": "Company Name" }, "COMPANY_DOMAIN": { "type": "string", "enum": [ "unchanged", "changed", "became_available", "became_unavailable", "unavailable" ], "title": "Company Domain" } }, "type": "object", "required": [ "JOB_TITLE", "COMPANY_NAME", "COMPANY_DOMAIN" ], "title": "EmploymentComparison" }, "EnrichmentMatch": { "properties": { "key": { "type": "string", "title": "Key" }, "status": { "type": "string", "enum": [ "matched", "ambiguous", "conflicting", "not_found" ], "title": "Status" }, "record_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Record Id" }, "version_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version Id" } }, "type": "object", "required": [ "key", "status" ], "title": "EnrichmentMatch" }, "ExclusionBatchIn": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ExclusionIn" }, "type": "array", "maxItems": 200, "minItems": 1, "title": "Items" } }, "additionalProperties": false, "type": "object", "required": [ "items" ], "title": "ExclusionBatchIn" }, "ExclusionHistory": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ExclusionOriginal" }, "type": "array", "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Next Cursor" } }, "additionalProperties": false, "type": "object", "required": [ "items", "next_cursor" ], "title": "ExclusionHistory" }, "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" }, "ExclusionOriginal": { "properties": { "seq": { "type": "integer", "title": "Seq" }, "id": { "type": "string", "title": "Id" }, "scope": { "type": "string", "enum": [ "email", "domain" ], "title": "Scope" }, "email": { "type": "string", "title": "Email", "description": "Present only for email scope." }, "domain": { "type": "string", "title": "Domain", "description": "Present only for domain scope." }, "reason": { "type": "string", "title": "Reason" }, "evidence": { "type": "string", "title": "Evidence" }, "actor": { "type": "string", "title": "Actor" }, "added": { "type": "integer", "enum": [ 0, 1 ], "title": "Added" }, "created_at": { "type": "number", "title": "Created At" } }, "additionalProperties": false, "type": "object", "required": [ "seq", "id", "scope", "reason", "evidence", "actor", "added", "created_at" ], "title": "ExclusionOriginal" }, "ExclusionPage": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ExclusionRecord" }, "type": "array", "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "additionalProperties": false, "type": "object", "required": [ "items", "next_cursor" ], "title": "ExclusionPage" }, "ExclusionRecord": { "properties": { "scope": { "type": "string", "enum": [ "email", "domain" ], "title": "Scope" }, "email": { "type": "string", "title": "Email", "description": "Present only for email scope." }, "domain": { "type": "string", "title": "Domain", "description": "Present only for domain scope." }, "reason": { "type": "string", "title": "Reason" }, "created_at": { "type": "number", "title": "Created At" }, "cleanup_pending": { "type": "integer", "enum": [ 0, 1 ], "title": "Cleanup Pending" } }, "additionalProperties": false, "type": "object", "required": [ "scope", "reason", "created_at", "cleanup_pending" ], "title": "ExclusionRecord" }, "ExclusionResults": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ExclusionOriginal" }, "type": "array", "title": "Items" } }, "additionalProperties": false, "type": "object", "required": [ "items" ], "title": "ExclusionResults" }, "ExpansionReceipt": { "properties": { "additional_cents": { "type": "integer", "title": "Additional Cents" }, "added_daily_sends": { "type": "integer", "title": "Added Daily Sends" }, "allocated_daily_sends": { "type": "integer", "title": "Allocated Daily Sends" }, "lease_until": { "type": "string", "title": "Lease Until" }, "committed_at": { "type": "string", "title": "Committed At" }, "next_term_cents": { "type": "integer", "title": "Next Term Cents" } }, "additionalProperties": false, "type": "object", "required": [ "additional_cents", "added_daily_sends", "allocated_daily_sends", "lease_until", "committed_at", "next_term_cents" ], "title": "ExpansionReceipt" }, "FacetOption": { "properties": { "value": { "type": "string", "title": "Value" }, "count": { "type": "integer", "minimum": 0.0, "title": "Count" } }, "additionalProperties": false, "type": "object", "required": [ "value", "count" ], "title": "FacetOption" }, "FacetPage": { "properties": { "field": { "type": "string", "title": "Field" }, "options": { "items": { "$ref": "#/components/schemas/FacetOption" }, "type": "array", "title": "Options" }, "count_status": { "type": "string", "enum": [ "exact", "estimated", "lower_bound" ], "title": "Count Status" }, "count_error_upper_bound": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Count Error Upper Bound" }, "scanned_candidates": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Scanned Candidates" }, "truncated": { "type": "boolean", "title": "Truncated" }, "observed_at": { "type": "string", "title": "Observed At" } }, "additionalProperties": false, "type": "object", "required": [ "field", "options", "count_status", "count_error_upper_bound", "truncated", "observed_at" ], "title": "FacetPage" }, "FacetRequest": { "properties": { "query": { "$ref": "#/components/schemas/SearchQuery-Input" }, "field": { "type": "string", "maxLength": 80, "minLength": 1, "title": "Field" }, "text": { "type": "string", "maxLength": 80, "pattern": "^[^\\x00-\\x1f\\x7f]*$", "title": "Text", "default": "" }, "limit": { "type": "integer", "maximum": 100.0, "minimum": 1.0, "title": "Limit", "default": 50 } }, "additionalProperties": false, "type": "object", "required": [ "query", "field" ], "title": "FacetRequest" }, "FieldDefinition": { "properties": { "label": { "type": "string", "title": "Label" }, "group": { "type": "string", "enum": [ "Contact", "Company" ], "title": "Group" }, "type": { "type": "string", "enum": [ "text", "date", "number", "integer", "strings", "text_list", "work_history", "education_history", "posts" ], "title": "Type" }, "operators": { "items": { "type": "string" }, "type": "array", "title": "Operators" }, "normalization": { "type": "string", "enum": [ "none", "email", "phone", "person_linkedin", "company_linkedin", "domain" ], "title": "Normalization" }, "searchable": { "type": "boolean", "title": "Searchable" }, "facetable": { "type": "boolean", "title": "Facetable", "default": false }, "preview": { "type": "boolean", "title": "Preview" }, "exportable": { "type": "boolean", "title": "Exportable" }, "fields": { "anyOf": [ { "additionalProperties": { "$ref": "#/components/schemas/NestedFieldDefinition" }, "type": "object" }, { "type": "null" } ], "title": "Fields" } }, "type": "object", "required": [ "label", "group", "type", "operators", "normalization", "searchable", "preview", "exportable" ], "title": "FieldDefinition" }, "FileReceipt": { "properties": { "format": { "type": "string", "enum": [ "csv_v1", "json_v1", "jsonl_v1", "xlsx_v1" ], "title": "Format", "default": "csv_v1" }, "columns": { "items": { "type": "string" }, "type": "array", "title": "Columns", "description": "Ordered column names recorded when this file was created." }, "rows": { "type": "integer", "maximum": 5000000.0, "minimum": 0.0, "title": "Rows" }, "bytes": { "type": "integer", "maximum": 4294967296.0, "minimum": 1.0, "title": "Bytes" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$", "title": "Sha256" }, "snapshot_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Snapshot At", "description": "Exclusion exports: consistent database snapshot established when file generation begins." } }, "type": "object", "required": [ "columns", "rows", "bytes", "sha256" ], "title": "FileReceipt" }, "FilterOption": { "properties": { "value": { "type": "string", "maxLength": 256, "minLength": 1, "pattern": "^[^\\x00-\\x1f\\x7f]+$", "title": "Value" }, "label": { "type": "string", "maxLength": 200, "minLength": 1, "pattern": "^[^\\x00-\\x1f\\x7f]+$", "title": "Label" } }, "additionalProperties": false, "type": "object", "required": [ "value", "label" ], "title": "FilterOption" }, "FilterOptions": { "properties": { "version": { "type": "string", "maxLength": 100, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "title": "Version" }, "fields": { "items": { "$ref": "#/components/schemas/FilterVocabulary" }, "type": "array", "maxItems": 16, "minItems": 1, "title": "Fields" } }, "additionalProperties": false, "type": "object", "required": [ "version", "fields" ], "title": "FilterOptions" }, "FilterVocabulary": { "properties": { "entity_type": { "type": "string", "enum": [ "person", "company" ], "title": "Entity Type" }, "field": { "type": "string", "maxLength": 80, "minLength": 1, "title": "Field" }, "options": { "items": { "$ref": "#/components/schemas/FilterOption" }, "type": "array", "maxItems": 256, "minItems": 1, "title": "Options" } }, "additionalProperties": false, "type": "object", "required": [ "entity_type", "field", "options" ], "title": "FilterVocabulary" }, "FundingAmount": { "properties": { "amount_minor": { "type": "integer", "maximum": 100000.0, "minimum": 500.0, "title": "Amount Minor" }, "currency": { "type": "string", "const": "usd", "title": "Currency", "default": "usd" }, "billing_revision": { "type": "integer", "minimum": 0.0, "title": "Billing Revision" } }, "additionalProperties": false, "type": "object", "required": [ "amount_minor", "billing_revision" ], "title": "FundingAmount" }, "FundingConfirmation": { "properties": { "review_id": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Review Id" }, "expected_digest": { "type": "string", "pattern": "^[a-f0-9]{64}$", "title": "Expected Digest" } }, "additionalProperties": false, "type": "object", "required": [ "review_id", "expected_digest" ], "title": "FundingConfirmation" }, "FundingHistory": { "properties": { "items": { "items": { "$ref": "#/components/schemas/FundingHistoryItem" }, "type": "array", "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "additionalProperties": false, "type": "object", "required": [ "items" ], "title": "FundingHistory" }, "FundingHistoryItem": { "properties": { "id": { "type": "string", "title": "Id" }, "digest": { "type": "string", "title": "Digest" }, "amount_minor": { "type": "integer", "title": "Amount Minor" }, "currency": { "type": "string", "const": "usd", "title": "Currency", "default": "usd" }, "policy_id": { "type": "string", "enum": [ "data-funding-test-v1", "data-funding-live-v1" ], "title": "Policy Id" }, "method": { "type": "string", "title": "Method" }, "reviewed_method": { "anyOf": [ { "$ref": "#/components/schemas/ReviewedCard" }, { "type": "null" } ], "description": "Immutable original reviewed card label, not the current default or a later recovery method. Null means unavailable; never backfilled from live card metadata." }, "billing_revision": { "type": "integer", "title": "Billing Revision" }, "mode": { "type": "string", "enum": [ "test", "live" ], "title": "Mode" }, "state": { "type": "string", "enum": [ "reviewed", "pending", "completed", "cancelled", "expired" ], "title": "State" }, "created_at": { "type": "number", "title": "Created At" }, "expires_at": { "type": "number", "title": "Expires At" }, "automatic": { "type": "boolean", "title": "Automatic" }, "submitted_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Submitted At" } }, "additionalProperties": false, "type": "object", "required": [ "id", "digest", "amount_minor", "policy_id", "method", "billing_revision", "mode", "state", "created_at", "expires_at", "automatic" ], "title": "FundingHistoryItem" }, "FundingReadiness": { "properties": { "state": { "type": "string", "enum": [ "ready", "card_required", "consent_required", "unavailable", "restricted", "attention" ], "title": "State" }, "available_minor": { "type": "integer", "title": "Available Minor" }, "has_card": { "type": "boolean", "title": "Has Card" }, "automatic_charge_minor": { "type": "integer", "title": "Automatic Charge Minor", "default": 0 }, "blocker": { "type": "string", "title": "Blocker", "default": "" } }, "additionalProperties": false, "type": "object", "required": [ "state", "available_minor", "has_card" ], "title": "FundingReadiness" }, "FundingReview": { "properties": { "id": { "type": "string", "title": "Id" }, "digest": { "type": "string", "title": "Digest" }, "amount_minor": { "type": "integer", "title": "Amount Minor" }, "currency": { "type": "string", "const": "usd", "title": "Currency", "default": "usd" }, "policy_id": { "type": "string", "enum": [ "data-funding-test-v1", "data-funding-live-v1" ], "title": "Policy Id" }, "method": { "type": "string", "title": "Method" }, "reviewed_method": { "anyOf": [ { "$ref": "#/components/schemas/ReviewedCard" }, { "type": "null" } ], "description": "Immutable original reviewed card label, not the current default or a later recovery method. Null means unavailable; never backfilled from live card metadata." }, "billing_revision": { "type": "integer", "title": "Billing Revision" }, "mode": { "type": "string", "enum": [ "test", "live" ], "title": "Mode" }, "state": { "type": "string", "enum": [ "reviewed", "pending", "completed", "cancelled", "expired" ], "title": "State" }, "created_at": { "type": "number", "title": "Created At" }, "expires_at": { "type": "number", "title": "Expires At" } }, "additionalProperties": false, "type": "object", "required": [ "id", "digest", "amount_minor", "policy_id", "method", "billing_revision", "mode", "state", "created_at", "expires_at" ], "title": "FundingReview" }, "FundingView": { "properties": { "id": { "type": "string", "title": "Id" }, "digest": { "type": "string", "title": "Digest" }, "amount_minor": { "type": "integer", "title": "Amount Minor" }, "currency": { "type": "string", "const": "usd", "title": "Currency", "default": "usd" }, "policy_id": { "type": "string", "enum": [ "data-funding-test-v1", "data-funding-live-v1" ], "title": "Policy Id" }, "method": { "type": "string", "title": "Method" }, "reviewed_method": { "anyOf": [ { "$ref": "#/components/schemas/ReviewedCard" }, { "type": "null" } ], "description": "Immutable original reviewed card label, not the current default or a later recovery method. Null means unavailable; never backfilled from live card metadata." }, "billing_revision": { "type": "integer", "title": "Billing Revision" }, "mode": { "type": "string", "enum": [ "test", "live" ], "title": "Mode" }, "state": { "type": "string", "enum": [ "reviewed", "pending", "completed", "cancelled", "expired" ], "title": "State" }, "created_at": { "type": "number", "title": "Created At" }, "expires_at": { "type": "number", "title": "Expires At" }, "status": { "type": "string", "enum": [ "reviewed", "creation_unknown", "requires_payment_method", "requires_confirmation", "requires_action", "processing", "succeeded", "canceled", "expired" ], "title": "Status" }, "client_secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Client Secret" } }, "additionalProperties": false, "type": "object", "required": [ "id", "digest", "amount_minor", "policy_id", "method", "billing_revision", "mode", "state", "created_at", "expires_at", "status" ], "title": "FundingView" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "HandoffRecipient": { "properties": { "id": { "type": "string", "title": "Id" }, "email": { "type": "string", "title": "Email" }, "name": { "type": "string", "title": "Name" } }, "additionalProperties": false, "type": "object", "required": [ "id", "email", "name" ], "title": "HandoffRecipient" }, "HandoffSnapshot": { "properties": { "person": { "$ref": "#/components/schemas/HandoffRecipient" }, "route": { "$ref": "#/components/schemas/ReplyRule" }, "config_revision": { "type": "integer", "title": "Config Revision" }, "recipients": { "items": { "type": "string" }, "type": "array", "maxItems": 2, "minItems": 2, "title": "Recipients" } }, "additionalProperties": false, "type": "object", "required": [ "person", "route", "config_revision", "recipients" ], "title": "HandoffSnapshot" }, "HistoricalPlacementProviders": { "additionalProperties": true, "type": "object", "title": "HistoricalPlacementProviders", "description": "Retained provider maps predate placement-v1 normalization and are returned without revalidation.", "x-opaque-reason": "Historical provider group keys and values are immutable evidence predating placement-v1 normalization." }, "IdentifierDefinition": { "properties": { "label": { "type": "string", "title": "Label" }, "fields": { "items": { "type": "string" }, "type": "array", "title": "Fields" }, "default": { "type": "boolean", "title": "Default" } }, "type": "object", "required": [ "label", "fields", "default" ], "title": "IdentifierDefinition" }, "IdentifierUnlock": { "properties": { "inputs": { "items": { "$ref": "#/components/schemas/ResolveInput" }, "type": "array", "maxItems": 100, "minItems": 1, "title": "Inputs" }, "policy_id": { "type": "string", "maxLength": 100, "minLength": 1, "title": "Policy Id" }, "currency": { "type": "string", "const": "usd", "title": "Currency", "default": "usd" }, "max_amount_minor": { "type": "integer", "maximum": 10000000.0, "minimum": 0.0, "title": "Max Amount Minor" }, "action": { "type": "string", "const": "unlock", "title": "Action" }, "resource": { "type": "string", "enum": [ "people", "companies" ], "title": "Resource" } }, "additionalProperties": false, "type": "object", "required": [ "inputs", "policy_id", "max_amount_minor", "action", "resource" ], "title": "IdentifierUnlock" }, "ImportCapabilities": { "properties": { "kinds": { "items": { "type": "string" }, "type": "array", "title": "Kinds", "default": [ "records", "identifiers", "ids", "suppressions", "contact_history" ] }, "formats": { "items": { "type": "string", "enum": [ "csv", "ndjson" ] }, "type": "array", "title": "Formats", "default": [ "csv", "ndjson" ] }, "column_schemas": { "items": { "$ref": "#/components/schemas/ImportColumnSchema" }, "type": "array", "title": "Column Schemas", "description": "Accepted staging columns, including optional caller key. Identifier availability additionally requires the current search schema." }, "max_columns": { "type": "integer", "title": "Max Columns", "default": 200 }, "campaign_fields": { "type": "boolean", "title": "Campaign Fields", "description": "Person record uploads accept an optional campaign_fields string map; CSV targets use campaign_fields.. These supplied variables are for campaign admission, not catalogue data.", "default": true }, "max_chunk_bytes": { "type": "integer", "title": "Max Chunk Bytes", "default": 1048576 }, "max_chunk_rows": { "type": "integer", "title": "Max Chunk Rows", "default": 1000 }, "max_chunks": { "type": "integer", "title": "Max Chunks", "default": 50000 }, "max_row_bytes": { "type": "integer", "title": "Max Row Bytes", "default": 270336 }, "max_rows": { "type": "integer", "title": "Max Rows", "default": 5000000 }, "max_bytes": { "type": "integer", "title": "Max Bytes", "default": 8589934592 }, "workspace_reserved_bytes": { "type": "integer", "title": "Workspace Reserved Bytes", "default": 17179869184 }, "global_reserved_bytes": { "type": "integer", "title": "Global Reserved Bytes", "default": 68719476736 }, "workspace_reserved_rows": { "type": "integer", "title": "Workspace Reserved Rows", "default": 5000000 }, "global_reserved_rows": { "type": "integer", "title": "Global Reserved Rows", "default": 20000000 }, "workspace_active_imports": { "type": "integer", "title": "Workspace Active Imports", "default": 100 }, "global_active_imports": { "type": "integer", "title": "Global Active Imports", "default": 1000 }, "retention_seconds": { "type": "integer", "title": "Retention Seconds", "default": 86400 }, "execution_enabled": { "type": "boolean", "title": "Execution Enabled", "default": true } }, "type": "object", "required": [ "column_schemas" ], "title": "ImportCapabilities" }, "ImportColumnSchema": { "properties": { "kind": { "type": "string", "enum": [ "records", "identifiers", "ids", "suppressions", "contact_history" ], "title": "Kind" }, "entity_type": { "anyOf": [ { "type": "string", "enum": [ "person", "company" ] }, { "type": "null" } ], "title": "Entity Type" }, "fields": { "items": { "type": "string" }, "type": "array", "title": "Fields" } }, "type": "object", "required": [ "kind", "entity_type", "fields" ], "title": "ImportColumnSchema" }, "ImportCreate": { "properties": { "entity_type": { "anyOf": [ { "type": "string", "enum": [ "person", "company" ] }, { "type": "null" } ], "title": "Entity Type" }, "kind": { "type": "string", "enum": [ "records", "identifiers", "ids", "suppressions", "contact_history" ], "title": "Kind" }, "defaults": { "anyOf": [ { "$ref": "#/components/schemas/SuppressionDefaults" }, { "type": "null" } ] }, "history_source": { "anyOf": [ { "type": "string", "maxLength": 200, "minLength": 1, "pattern": "^[^\\x00-\\x1f\\x7f]+$" }, { "type": "null" } ], "title": "History Source", "description": "Optional immutable source label for contact-history rows without their own source column." }, "format": { "type": "string", "enum": [ "ndjson", "csv" ], "title": "Format", "default": "ndjson" }, "columns": { "additionalProperties": { "type": "string" }, "type": "object", "maxProperties": 200, "title": "Columns" }, "max_rows": { "type": "integer", "maximum": 5000000.0, "minimum": 1.0, "title": "Max Rows" }, "max_bytes": { "type": "integer", "maximum": 8589934592.0, "minimum": 1.0, "title": "Max Bytes" } }, "additionalProperties": false, "type": "object", "required": [ "kind", "max_rows", "max_bytes" ], "title": "ImportCreate" }, "ImportRow": { "properties": { "ordinal": { "type": "integer", "title": "Ordinal" }, "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Key" }, "data": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Data" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" } }, "type": "object", "required": [ "ordinal", "key", "data", "error" ], "title": "ImportRow" }, "ImportRows": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ImportRow" }, "type": "array", "title": "Items" }, "next_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Next After" } }, "type": "object", "required": [ "items", "next_after" ], "title": "ImportRows" }, "ImportSeal": { "properties": { "expected_chunks": { "type": "integer", "maximum": 50000.0, "minimum": 1.0, "title": "Expected Chunks" }, "expected_rows": { "type": "integer", "maximum": 5000000.0, "minimum": 1.0, "title": "Expected Rows" }, "expected_digest": { "type": "string", "pattern": "^[a-f0-9]{64}$", "title": "Expected Digest" }, "allow_invalid_rows": { "type": "boolean", "title": "Allow Invalid Rows", "default": false } }, "additionalProperties": false, "type": "object", "required": [ "expected_chunks", "expected_rows", "expected_digest" ], "title": "ImportSeal" }, "ImportView": { "properties": { "id": { "type": "string", "title": "Id" }, "state": { "type": "string", "enum": [ "uploading", "sealed", "cancelled", "expired" ], "title": "State" }, "parameters": { "$ref": "#/components/schemas/ManifestConfig" }, "chunks": { "type": "integer", "title": "Chunks" }, "rows": { "type": "integer", "title": "Rows" }, "valid_rows": { "type": "integer", "title": "Valid Rows" }, "invalid_rows": { "type": "integer", "title": "Invalid Rows" }, "uploaded_bytes": { "type": "integer", "title": "Uploaded Bytes" }, "digest": { "type": "string", "title": "Digest" }, "created_at": { "type": "string", "title": "Created At" }, "expires_at": { "type": "string", "title": "Expires At" }, "sealed_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sealed At" }, "purged": { "type": "boolean", "title": "Purged" } }, "type": "object", "required": [ "id", "state", "parameters", "chunks", "rows", "valid_rows", "invalid_rows", "uploaded_bytes", "digest", "created_at", "expires_at", "sealed_at", "purged" ], "title": "ImportView" }, "InboundAvailability": { "properties": { "observed_at": { "type": "number", "title": "Observed At" }, "available_daily_limit": { "type": "integer", "minimum": 0.0, "title": "Available Daily Limit" }, "available_remaining_units": { "type": "integer", "minimum": 0.0, "title": "Available Remaining Units" }, "unavailable_mailboxes": { "type": "integer", "minimum": 0.0, "title": "Unavailable Mailboxes" }, "issues": { "items": { "$ref": "#/components/schemas/InboundIssue" }, "type": "array", "maxItems": 1000, "title": "Issues" } }, "type": "object", "required": [ "observed_at", "available_daily_limit", "available_remaining_units", "unavailable_mailboxes", "issues" ], "title": "InboundAvailability" }, "InboundIssue": { "properties": { "mailbox": { "type": "string", "title": "Mailbox" }, "reason": { "type": "string", "title": "Reason" }, "last_checked_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Last Checked At" }, "last_success_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Last Success At" }, "failure_since": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Failure Since" }, "failure_count": { "type": "integer", "minimum": 0.0, "title": "Failure Count" }, "next_retry_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Next Retry At" }, "duration_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Duration Ms" }, "severity": { "type": "string", "enum": [ "retrying", "attention" ], "title": "Severity" } }, "type": "object", "required": [ "mailbox", "reason", "last_checked_at", "last_success_at", "failure_since", "failure_count", "next_retry_at", "duration_ms", "severity" ], "title": "InboundIssue" }, "InboundMessage": { "properties": { "seq": { "type": "integer", "title": "Seq" }, "direction": { "type": "string", "enum": [ "in", "out" ], "title": "Direction" }, "authorship": { "type": "string", "enum": [ "external", "campaign", "human", "automation" ], "title": "Authorship" }, "occurred_at": { "type": "number", "title": "Occurred At" }, "event_id": { "type": "string", "title": "Event Id" }, "message_id": { "type": "string", "title": "Message Id" }, "kind": { "type": "string", "title": "Kind" }, "content": { "type": "string", "title": "Content" }, "intent": { "type": "string", "title": "Intent" }, "revision": { "type": "integer", "title": "Revision" }, "delivery_action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Delivery Action" }, "delivery_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Delivery Status" }, "delivery_confidence": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Delivery Confidence" }, "classification": { "anyOf": [ { "$ref": "#/components/schemas/ReplyClassificationObservation" }, { "$ref": "#/components/schemas/AgentClassificationObservation" } ], "title": "Classification" }, "participants": { "anyOf": [ { "$ref": "#/components/schemas/MessageParticipants" }, { "type": "null" } ] }, "subject": { "type": "string", "title": "Subject" }, "attachments": { "items": { "$ref": "#/components/schemas/MessageAttachment" }, "type": "array", "title": "Attachments" }, "attachments_state": { "type": "string", "enum": [ "available", "none", "unavailable", "original_only" ], "title": "Attachments State" } }, "additionalProperties": false, "type": "object", "required": [ "seq", "direction", "authorship", "occurred_at", "event_id", "message_id", "kind", "content", "intent", "revision", "delivery_action", "delivery_status", "delivery_confidence", "participants" ], "title": "InboundMessage" }, "InboxEvent": { "properties": { "event_id": { "type": "string", "title": "Event Id" }, "message_id": { "type": "string", "title": "Message Id" }, "kind": { "type": "string", "title": "Kind" }, "content": { "type": "string", "title": "Content" }, "received_at": { "type": "number", "title": "Received At" }, "intent": { "type": "string", "title": "Intent" }, "revision": { "type": "integer", "title": "Revision" } }, "additionalProperties": false, "type": "object", "required": [ "event_id", "message_id", "kind", "content", "received_at", "intent", "revision" ], "title": "InboxEvent" }, "InboxPage": { "properties": { "items": { "items": { "$ref": "#/components/schemas/InboxEvent" }, "type": "array", "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "additionalProperties": false, "type": "object", "required": [ "items", "next_cursor" ], "title": "InboxPage" }, "IncludedAdmission": { "properties": { "person_id": { "type": "string", "title": "Person Id" }, "grant_id": { "type": "string", "title": "Grant Id" }, "benefit_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Benefit Id" }, "planned_at": { "type": "number", "title": "Planned At" }, "access_origin": { "type": "string", "enum": [ "included_sequence", "already_owned" ], "title": "Access Origin" } }, "type": "object", "required": [ "person_id", "grant_id", "benefit_id", "planned_at", "access_origin" ], "title": "IncludedAdmission" }, "IncludedPreparationCounts": { "properties": { "name_checks_authorized": { "type": "integer", "title": "Name Checks Authorized", "default": 0 }, "name_reserve_authorized_usd_micros": { "type": "integer", "title": "Name Reserve Authorized Usd Micros", "default": 0 }, "candidates": { "type": "integer", "title": "Candidates", "default": 0 }, "checks_authorized": { "type": "integer", "title": "Checks Authorized", "default": 0 }, "check_cost_authorized_cents": { "type": "integer", "title": "Check Cost Authorized Cents", "default": 0 }, "pending": { "type": "integer", "title": "Pending", "default": 0 }, "validated": { "type": "integer", "title": "Validated", "default": 0 }, "held": { "type": "integer", "title": "Held", "default": 0 }, "cancelled": { "type": "integer", "title": "Cancelled", "default": 0 }, "included": { "type": "integer", "title": "Included", "default": 0 }, "admitted": { "type": "integer", "title": "Admitted", "default": 0 }, "grant_waits": { "additionalProperties": { "type": "integer" }, "type": "object", "title": "Grant Waits" }, "held_reasons": { "additionalProperties": { "type": "integer" }, "propertyNames": { "enum": [ "included_preparation_email_required", "included_preparation_source_invalid", "included_preparation_email_not_valid", "included_preparation_check_ceiling", "included_preparation_verification_unresolved", "included_preparation_provider_budget_exhausted", "included_preparation_authority_ended" ] }, "type": "object", "title": "Held Reasons" } }, "type": "object", "title": "IncludedPreparationCounts" }, "IncludedPreparationTerms": { "properties": { "grant_contacts": { "type": "boolean", "title": "Grant Contacts", "default": false }, "max_candidates": { "type": "integer", "maximum": 2000.0, "minimum": 1.0, "title": "Max Candidates" }, "max_checks": { "type": "integer", "maximum": 2000.0, "minimum": 0.0, "title": "Max Checks" }, "max_check_cost_cents": { "type": "integer", "maximum": 100000000.0, "minimum": 0.0, "title": "Max Check Cost Cents" }, "max_name_checks": { "type": "integer", "maximum": 2000.0, "minimum": 0.0, "title": "Max Name Checks", "default": 0 }, "max_name_reserve_usd_micros": { "type": "integer", "maximum": 2000000.0, "minimum": 0.0, "title": "Max Name Reserve Usd Micros", "default": 0 } }, "additionalProperties": false, "type": "object", "required": [ "max_candidates", "max_checks", "max_check_cost_cents" ], "title": "IncludedPreparationTerms" }, "Insight": { "properties": { "code": { "type": "string", "title": "Code" }, "campaign": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Campaign" }, "severity": { "type": "string", "enum": [ "info", "warning" ], "title": "Severity" }, "count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Count" }, "action": { "type": "string", "enum": [ "inspect", "refill", "review_capacity", "refresh" ], "title": "Action" } }, "additionalProperties": false, "type": "object", "required": [ "code", "severity", "action" ], "title": "Insight" }, "IntentResult": { "properties": { "intent": { "type": "string", "title": "Intent" }, "revision": { "type": "integer", "title": "Revision" }, "replayed": { "type": "boolean", "title": "Replayed" } }, "additionalProperties": false, "type": "object", "required": [ "intent", "revision", "replayed" ], "title": "IntentResult" }, "JobArtifact": { "properties": { "job_id": { "type": "string", "title": "Job Id" }, "state": { "type": "string", "enum": [ "pending", "publishing", "ready", "failed", "cancelled", "expired" ], "title": "State" }, "reserved_bytes": { "type": "integer", "title": "Reserved Bytes" }, "expires_at": { "type": "string", "title": "Expires At" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" }, "receipt": { "anyOf": [ { "$ref": "#/components/schemas/FileReceipt" }, { "type": "null" } ] } }, "type": "object", "required": [ "job_id", "state", "reserved_bytes", "expires_at", "reason", "receipt" ], "title": "JobArtifact" }, "JobCampaignProgress": { "properties": { "processed": { "type": "integer", "title": "Processed", "default": 0 }, "added": { "type": "integer", "title": "Added", "default": 0 }, "held": { "type": "integer", "title": "Held", "default": 0 }, "already_admitted": { "type": "integer", "title": "Already Admitted", "default": 0 }, "reason_counts": { "anyOf": [ { "additionalProperties": { "type": "integer" }, "type": "object" }, { "type": "null" } ], "title": "Reason Counts", "description": "Recorded admission/duplicate reasons for processed rows. Absent on historical progress, never inferred as zero." }, "campaign_revision": { "type": "integer", "title": "Campaign Revision" }, "audience_revision": { "type": "integer", "title": "Audience Revision" } }, "type": "object", "required": [ "campaign_revision", "audience_revision" ], "title": "JobCampaignProgress" }, "JobCapabilities": { "properties": { "kinds": { "items": { "type": "string" }, "type": "array", "title": "Kinds", "default": [ "import_records", "list_membership", "suppressions", "contact_history", "export_suppressions", "export_campaign", "campaign_admission" ] }, "max_records": { "type": "integer", "title": "Max Records", "default": 5000000 }, "chunk_rows": { "type": "integer", "title": "Chunk Rows", "default": 100 }, "workspace_active_jobs": { "type": "integer", "title": "Workspace Active Jobs", "default": 10 }, "global_active_jobs": { "type": "integer", "title": "Global Active Jobs", "default": 100 }, "lifetime_seconds": { "type": "integer", "title": "Lifetime Seconds", "default": 604800 }, "worker_recent": { "type": "boolean", "title": "Worker Recent", "default": false }, "file_worker_recent": { "type": "boolean", "title": "File Worker Recent", "default": false }, "provider_jobs_enabled": { "type": "boolean", "title": "Provider Jobs Enabled", "default": false }, "source_check_rows": { "type": "integer", "title": "Source Check Rows", "default": 25 }, "source_check_worker_recent": { "type": "boolean", "title": "Source Check Worker Recent", "default": false }, "exports_enabled": { "type": "boolean", "title": "Exports Enabled", "default": true }, "preparation_enabled": { "type": "boolean", "title": "Preparation Enabled", "default": true }, "file_max_bytes": { "type": "integer", "title": "File Max Bytes", "default": 4294967296 }, "workspace_files": { "type": "integer", "title": "Workspace Files", "default": 2 }, "global_files": { "type": "integer", "title": "Global Files", "default": 8 }, "unlock_input_kinds": { "items": { "type": "string", "enum": [ "ids", "source_records", "source_versions", "identifiers" ] }, "type": "array", "title": "Unlock Input Kinds", "default": [] }, "refresh_input_kinds": { "items": { "type": "string", "const": "ids" }, "type": "array", "title": "Refresh Input Kinds", "default": [] }, "membership_scope_kinds": { "items": { "type": "string", "enum": [ "ids", "list", "query", "records" ] }, "type": "array", "title": "Membership Scope Kinds", "default": [ "ids", "list", "records" ] }, "membership_scope_resources": { "items": { "type": "string", "enum": [ "contacts", "accounts", "people", "companies" ] }, "type": "array", "title": "Membership Scope Resources", "default": [ "contacts", "accounts" ] }, "campaign_scope_kinds": { "items": { "type": "string", "enum": [ "ids", "list", "records" ] }, "type": "array", "title": "Campaign Scope Kinds", "default": [ "ids", "list", "records" ] }, "campaign_scope_resources": { "items": { "type": "string", "const": "contacts" }, "type": "array", "title": "Campaign Scope Resources", "default": [ "contacts" ] }, "max_scope_ids": { "type": "integer", "title": "Max Scope Ids", "default": 1000 }, "company_caps_enabled": { "type": "boolean", "title": "Company Caps Enabled", "default": false }, "unlock_scope_kinds": { "items": { "type": "string", "enum": [ "ids", "list", "query", "records" ] }, "type": "array", "title": "Unlock Scope Kinds", "default": [] }, "unlock_scope_resources": { "items": { "type": "string", "enum": [ "contacts", "accounts", "people", "companies" ] }, "type": "array", "title": "Unlock Scope Resources", "default": [] }, "refresh_scope_kinds": { "items": { "type": "string", "enum": [ "ids", "list", "query", "records" ] }, "type": "array", "title": "Refresh Scope Kinds", "default": [] }, "refresh_scope_resources": { "items": { "type": "string", "enum": [ "contacts", "accounts", "people", "companies" ] }, "type": "array", "title": "Refresh Scope Resources", "default": [] }, "export_scope_kinds": { "items": { "type": "string", "enum": [ "ids", "list", "query", "records" ] }, "type": "array", "title": "Export Scope Kinds", "default": [ "ids", "list", "records" ] }, "export_scope_resources": { "items": { "type": "string", "enum": [ "contacts", "accounts", "people", "companies" ] }, "type": "array", "title": "Export Scope Resources", "default": [ "contacts", "accounts", "people", "companies" ] }, "export_input_kinds": { "items": { "type": "string", "enum": [ "ids", "identifiers" ] }, "type": "array", "title": "Export Input Kinds", "default": [ "ids" ] }, "export_version_modes": { "items": { "type": "string", "enum": [ "owned_only", "owned_or_new", "latest", "updates_only" ] }, "type": "array", "title": "Export Version Modes", "default": [ "owned_only" ] } }, "type": "object", "title": "JobCapabilities" }, "JobConfirm": { "properties": { "expected_revision": { "type": "integer", "minimum": 1.0, "title": "Expected Revision" }, "quote_revision": { "type": "integer", "minimum": 1.0, "title": "Quote Revision" }, "currency": { "type": "string", "const": "usd", "title": "Currency" }, "max_amount_minor": { "type": "integer", "maximum": 10000000.0, "minimum": 0.0, "title": "Max Amount Minor" }, "destination": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/JobExistingList" }, { "$ref": "#/components/schemas/JobNewList" } ], "discriminator": { "propertyName": "kind", "mapping": { "existing": "#/components/schemas/JobExistingList", "new": "#/components/schemas/JobNewList" } } }, { "type": "null" } ], "title": "Destination" } }, "additionalProperties": false, "type": "object", "required": [ "expected_revision", "quote_revision", "currency", "max_amount_minor" ], "title": "JobConfirm" }, "JobCounts": { "properties": { "processed": { "type": "integer", "title": "Processed", "default": 0 }, "created": { "type": "integer", "title": "Created", "default": 0 }, "added": { "type": "integer", "title": "Added", "default": 0 }, "removed": { "type": "integer", "title": "Removed", "default": 0 }, "unchanged": { "type": "integer", "title": "Unchanged", "default": 0 }, "invalid": { "type": "integer", "title": "Invalid", "default": 0 }, "newly_granted": { "type": "integer", "title": "Newly Granted", "default": 0 }, "already_owned": { "type": "integer", "title": "Already Owned", "default": 0 }, "excluded": { "type": "integer", "title": "Excluded", "default": 0 }, "checked": { "type": "integer", "title": "Checked", "default": 0 }, "changed": { "type": "integer", "title": "Changed", "default": 0 }, "missing": { "type": "integer", "title": "Missing", "default": 0 } }, "type": "object", "title": "JobCounts" }, "JobExistingList": { "properties": { "kind": { "type": "string", "const": "existing", "title": "Kind", "default": "existing" }, "list_id": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "List Id" }, "expected_membership_revision": { "type": "integer", "minimum": 1.0, "title": "Expected Membership Revision" } }, "additionalProperties": false, "type": "object", "required": [ "list_id", "expected_membership_revision" ], "title": "JobExistingList" }, "JobExport": { "properties": { "version_mode": { "type": "string", "enum": [ "owned_only", "owned_or_new", "latest", "updates_only" ], "title": "Version Mode", "default": "owned_only" }, "projection": { "type": "string", "enum": [ "effective", "licensed" ], "title": "Projection", "default": "effective" }, "fields": { "items": { "type": "string", "enum": [ "FIRST_NAME", "LAST_NAME", "MIDDLE_NAME", "JOB_TITLE", "DEPARTMENT", "SENIORITY_LEVEL", "HEADLINE", "SUMMARY", "SKILLS", "WORK_EXPERIENCE", "EDUCATION_HISTORY", "POSTS", "CURRENT_BUSINESS_EMAIL", "CURRENT_BUSINESS_EMAIL_VALIDATION_STATUS", "CURRENT_BUSINESS_EMAIL_VALIDATION_DATE", "EMAILS", "PHONES", "MOBILE_PHONE", "MOBILE_PHONE_VALIDATION_STATUS", "LINKEDIN_URL", "PERSONAL_CITY", "PERSONAL_STATE", "PERSONAL_COUNTRY", "PERSONAL_ADDRESS", "PERSONAL_ZIP", "LAST_UPDATED", "COMPANY_NAME", "COMPANY_DOMAIN", "COMPANY_DESCRIPTION", "COMPANY_INDUSTRY", "COMPANY_REVENUE_RANGE", "COMPANY_NUM_EMPLOYEE_RANGE", "COMPANY_OWNERSHIP", "COMPANY_LATEST_FUNDING_STAGE", "COMPANY_LATEST_FUNDING_ROUND_DATE", "COMPANY_TOTAL_FUNDING", "COMPANY_STOCK_EXCHANGE", "COMPANY_TICKER_SYMBOL", "COMPANY_STOCK_SYMBOL", "COMPANY_MARKET_CAPITALIZATION", "COMPANY_TOTAL_REVENUE", "COMPANY_NUMBER_OF_FOLLOWERS", "COMPANY_CITY", "COMPANY_STATE", "COMPANY_COUNTRY", "COMPANY_COUNTRY_NUMERIC", "COMPANY_ADDRESS", "COMPANY_ZIP_CODE", "COMPANY_FOUNDED_YEAR", "COMPANY_LINKEDIN_URL", "COMPANY_FACEBOOK_URL", "COMPANY_TWITTER_URL", "COMPANY_ANGELLIST_URL", "COMPANY_TECHNOLOGIES", "COMPANY_RETAIL_LOCATION_COUNT", "COMPANY_ID", "COMPANY_LOGO_URL" ] }, "type": "array", "maxItems": 55, "minItems": 1, "title": "Fields" }, "file_format": { "type": "string", "enum": [ "csv", "json", "jsonl", "xlsx" ], "title": "File Format", "default": "csv" }, "max_bytes": { "type": "integer", "maximum": 4294967296.0, "minimum": 1.0, "title": "Max Bytes", "default": 67108864 } }, "additionalProperties": false, "type": "object", "required": [ "fields" ], "title": "JobExport" }, "JobIdsScope": { "properties": { "kind": { "type": "string", "const": "ids", "title": "Kind" }, "resource": { "type": "string", "enum": [ "contacts", "accounts", "people", "companies" ], "title": "Resource" }, "ids": { "items": { "type": "string", "maxLength": 256, "minLength": 1, "pattern": "^[^\\x00-\\x1f\\x7f]+$" }, "type": "array", "maxItems": 1000, "minItems": 1, "title": "Ids" }, "max_per_company": { "anyOf": [ { "type": "integer", "maximum": 5000000.0, "minimum": 1.0 }, { "type": "null" } ], "title": "Max Per Company", "description": "People source IDs only. Company cap in supplied ID order before max_records; missing company IDs remain independent." } }, "additionalProperties": false, "type": "object", "required": [ "kind", "resource", "ids" ], "title": "JobIdsScope" }, "JobListScope": { "properties": { "kind": { "type": "string", "const": "list", "title": "Kind" }, "list_id": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "List Id" }, "expected_membership_revision": { "type": "integer", "minimum": 1.0, "title": "Expected Membership Revision" } }, "additionalProperties": false, "type": "object", "required": [ "kind", "list_id", "expected_membership_revision" ], "title": "JobListScope" }, "JobNewList": { "properties": { "kind": { "type": "string", "const": "new", "title": "Kind", "default": "new" }, "name": { "type": "string", "maxLength": 200, "minLength": 1, "title": "Name" } }, "additionalProperties": false, "type": "object", "required": [ "name" ], "title": "JobNewList" }, "JobQueryScope-Input": { "properties": { "kind": { "type": "string", "const": "query", "title": "Kind" }, "resource": { "type": "string", "enum": [ "people", "companies" ], "title": "Resource" }, "query": { "$ref": "#/components/schemas/SearchQuery-Input" }, "max_per_company": { "anyOf": [ { "type": "integer", "maximum": 5000000.0, "minimum": 1.0 }, { "type": "null" } ], "title": "Max Per Company", "description": "People only. Whole-query COMPANY_ID cap before max_records; missing company IDs remain independent." } }, "additionalProperties": false, "type": "object", "required": [ "kind", "resource", "query" ], "title": "JobQueryScope" }, "JobQueryScope-Output": { "properties": { "kind": { "type": "string", "const": "query", "title": "Kind" }, "resource": { "type": "string", "enum": [ "people", "companies" ], "title": "Resource" }, "query": { "$ref": "#/components/schemas/SearchQuery-Output" }, "max_per_company": { "anyOf": [ { "type": "integer", "maximum": 5000000.0, "minimum": 1.0 }, { "type": "null" } ], "title": "Max Per Company", "description": "People only. Whole-query COMPANY_ID cap before max_records; missing company IDs remain independent." } }, "additionalProperties": false, "type": "object", "required": [ "kind", "resource", "query" ], "title": "JobQueryScope" }, "JobQuote": { "properties": { "phase": { "type": "string", "enum": [ "preparing", "ready", "confirmed" ], "title": "Phase", "default": "preparing" }, "revision": { "type": "integer", "title": "Revision", "default": 1 }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "currency": { "type": "string", "const": "usd", "title": "Currency", "default": "usd" }, "amount_minor": { "type": "integer", "title": "Amount Minor", "default": 0 }, "counts": { "$ref": "#/components/schemas/JobQuoteCounts" }, "destination": { "anyOf": [ { "$ref": "#/components/schemas/JobExistingList" }, { "type": "null" } ] } }, "type": "object", "required": [ "phase", "revision", "expires_at", "currency", "amount_minor", "counts", "destination" ], "title": "JobQuote" }, "JobQuoteCounts": { "properties": { "selected": { "type": "integer", "title": "Selected", "default": 0 }, "deliverable": { "type": "integer", "title": "Deliverable", "default": 0 }, "excluded": { "type": "integer", "title": "Excluded", "default": 0 }, "owned_current": { "type": "integer", "title": "Owned Current", "default": 0 }, "owned_changed": { "type": "integer", "title": "Owned Changed", "default": 0 }, "owned_not_checked": { "type": "integer", "title": "Owned Not Checked", "default": 0 }, "needs_unlock": { "type": "integer", "title": "Needs Unlock", "default": 0 }, "provided": { "type": "integer", "title": "Provided", "default": 0 }, "unavailable": { "type": "integer", "title": "Unavailable", "default": 0 } }, "type": "object", "required": [ "selected", "deliverable", "excluded", "owned_current", "owned_changed", "owned_not_checked", "needs_unlock", "provided", "unavailable" ], "title": "JobQuoteCounts" }, "JobRecordFilter": { "properties": { "ownership": { "type": "string", "enum": [ "all", "net_new", "saved" ], "title": "Ownership", "default": "all" }, "q": { "type": "string", "maxLength": 200, "title": "Q", "default": "" }, "data_access": { "anyOf": [ { "type": "string", "const": "licensed" }, { "type": "null" } ], "title": "Data Access" }, "view": { "type": "string", "enum": [ "saved", "contacts" ], "title": "View", "default": "saved" }, "source_freshness": { "anyOf": [ { "type": "string", "enum": [ "current", "update_available", "unavailable" ] }, { "type": "null" } ], "title": "Source Freshness" } }, "additionalProperties": false, "type": "object", "title": "JobRecordFilter" }, "JobRecordsScope": { "properties": { "kind": { "type": "string", "const": "records", "title": "Kind" }, "resource": { "type": "string", "enum": [ "contacts", "accounts" ], "title": "Resource" }, "query": { "$ref": "#/components/schemas/JobRecordFilter" }, "list_id": { "anyOf": [ { "type": "string", "pattern": "^[a-f0-9]{32}$" }, { "type": "null" } ], "title": "List Id" }, "expected_membership_revision": { "anyOf": [ { "type": "integer", "minimum": 1.0 }, { "type": "null" } ], "title": "Expected Membership Revision" } }, "additionalProperties": false, "type": "object", "required": [ "kind", "resource", "query" ], "title": "JobRecordsScope" }, "JobRequest": { "properties": { "kind": { "type": "string", "enum": [ "import_records", "list_membership", "unlock", "refresh", "export", "suppressions", "contact_history", "export_suppressions", "export_campaign", "campaign_admission" ], "title": "Kind" }, "import_id": { "anyOf": [ { "type": "string", "pattern": "^[a-f0-9]{32}$" }, { "type": "null" } ], "title": "Import Id" }, "expected_digest": { "anyOf": [ { "type": "string", "pattern": "^[a-f0-9]{64}$" }, { "type": "null" } ], "title": "Expected Digest" }, "scope": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/JobIdsScope" }, { "$ref": "#/components/schemas/JobListScope" }, { "$ref": "#/components/schemas/JobQueryScope-Input" }, { "$ref": "#/components/schemas/JobRecordsScope" } ], "discriminator": { "propertyName": "kind", "mapping": { "ids": "#/components/schemas/JobIdsScope", "list": "#/components/schemas/JobListScope", "query": "#/components/schemas/JobQueryScope-Input", "records": "#/components/schemas/JobRecordsScope" } } }, { "type": "null" } ], "title": "Scope" }, "max_records": { "type": "integer", "maximum": 5000000.0, "minimum": 1.0, "title": "Max Records" }, "prepare": { "type": "boolean", "title": "Prepare", "description": "Prepare a native scoped action without spending or producing an artifact. Explicit confirmation is required before execution.", "default": false }, "list_id": { "anyOf": [ { "type": "string", "pattern": "^[a-f0-9]{32}$" }, { "type": "null" } ], "title": "List Id" }, "expected_membership_revision": { "anyOf": [ { "type": "integer", "minimum": 1.0 }, { "type": "null" } ], "title": "Expected Membership Revision" }, "action": { "type": "string", "enum": [ "add", "remove" ], "title": "Action", "default": "add" }, "purchase": { "anyOf": [ { "$ref": "#/components/schemas/OrderTerms" }, { "type": "null" } ] }, "export": { "anyOf": [ { "$ref": "#/components/schemas/JobExport" }, { "type": "null" } ] }, "review": { "type": "null", "title": "Review" }, "delivery": { "type": "null", "title": "Delivery" }, "campaign": { "anyOf": [ { "$ref": "#/components/schemas/CampaignAdmissionTarget" }, { "type": "null" } ] }, "exclusions": { "anyOf": [ { "$ref": "#/components/schemas/SuppressionExport" }, { "type": "null" } ] }, "recipients": { "anyOf": [ { "$ref": "#/components/schemas/CampaignExport" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "required": [ "kind", "max_records" ], "title": "JobRequest" }, "JobResult": { "properties": { "ordinal": { "type": "integer", "title": "Ordinal" }, "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Key" }, "record_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Record Id" }, "outcome": { "type": "string", "enum": [ "created", "added", "removed", "unchanged", "invalid", "newly_granted", "already_owned", "excluded", "checked", "changed", "missing" ], "title": "Outcome" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" }, "order_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Id" }, "version_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version Id" }, "grant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Grant Id" }, "amount_minor": { "type": "integer", "title": "Amount Minor", "default": 0 }, "source_check_revision": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Source Check Revision" }, "suppression_operation_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Suppression Operation Id" } }, "type": "object", "required": [ "ordinal", "key", "record_id", "outcome", "reason" ], "title": "JobResult" }, "JobResults": { "properties": { "items": { "items": { "$ref": "#/components/schemas/JobResult" }, "type": "array", "title": "Items" }, "next_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Next After" } }, "type": "object", "required": [ "items", "next_after" ], "title": "JobResults" }, "JobResume": { "properties": { "expected_revision": { "type": "integer", "minimum": 1.0, "title": "Expected Revision" }, "expected_membership_revision": { "anyOf": [ { "type": "integer", "minimum": 1.0 }, { "type": "null" } ], "title": "Expected Membership Revision" } }, "additionalProperties": false, "type": "object", "required": [ "expected_revision" ], "title": "JobResume" }, "JobView": { "properties": { "id": { "type": "string", "title": "Id" }, "parameters": { "$ref": "#/components/schemas/RecordedJobCreate" }, "entity_type": { "anyOf": [ { "type": "string", "enum": [ "person", "company" ] }, { "type": "null" } ], "title": "Entity Type" }, "state": { "type": "string", "enum": [ "queued", "action_required", "completed", "partial", "failed", "cancelled" ], "title": "State" }, "revision": { "type": "integer", "title": "Revision" }, "counts": { "$ref": "#/components/schemas/JobCounts" }, "total_rows": { "type": "integer", "title": "Total Rows" }, "total_rows_relation": { "type": "string", "enum": [ "eq", "ceiling" ], "title": "Total Rows Relation", "default": "eq" }, "target_revision": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Target Revision" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" }, "created_at": { "type": "string", "title": "Created At" }, "updated_at": { "type": "string", "title": "Updated At" }, "expires_at": { "type": "string", "title": "Expires At" }, "completed_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Completed At" }, "policy": { "anyOf": [ { "$ref": "#/components/schemas/DataPolicy" }, { "type": "null" } ] }, "amount_minor": { "type": "integer", "title": "Amount Minor", "default": 0 }, "funding_required_minor": { "type": "integer", "title": "Funding Required Minor", "default": 0 }, "pending_order_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pending Order Id" }, "quote": { "anyOf": [ { "$ref": "#/components/schemas/JobQuote" }, { "type": "null" } ] }, "campaign_progress": { "anyOf": [ { "$ref": "#/components/schemas/JobCampaignProgress" }, { "type": "null" } ] } }, "type": "object", "required": [ "id", "parameters", "entity_type", "state", "revision", "counts", "total_rows", "target_revision", "reason", "created_at", "updated_at", "expires_at", "completed_at" ], "title": "JobView" }, "JsonValue": {}, "KeywordGroup": { "properties": { "mode": { "type": "string", "enum": [ "OR", "AND", "EXCLUDE" ], "title": "Mode", "default": "OR" }, "keywords": { "items": { "type": "string", "maxLength": 256, "minLength": 1, "pattern": "^[^\\x00-\\x1f\\x7f]+$" }, "type": "array", "maxItems": 100, "minItems": 1, "title": "Keywords" }, "match_mode": { "type": "string", "enum": [ "exact", "like", "phrase" ], "title": "Match Mode", "default": "like" } }, "additionalProperties": false, "type": "object", "required": [ "keywords" ], "title": "KeywordGroup" }, "Keywords": { "properties": { "type": { "type": "string", "const": "keyword_group", "title": "Type" }, "operator": { "type": "string", "enum": [ "AND", "OR" ], "title": "Operator", "default": "AND" }, "groups": { "items": { "$ref": "#/components/schemas/KeywordGroup" }, "type": "array", "maxItems": 10, "minItems": 1, "title": "Groups" } }, "additionalProperties": false, "type": "object", "required": [ "type", "groups" ], "title": "Keywords" }, "LaunchIn": { "properties": { "id": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Id" }, "review_id": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Review Id" }, "capacity_operation": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Capacity Operation" } }, "additionalProperties": false, "type": "object", "required": [ "id", "review_id", "capacity_operation" ], "title": "LaunchIn" }, "LaunchResult": { "properties": { "id": { "type": "string", "title": "Id" }, "campaign": { "type": "string", "title": "Campaign" }, "state": { "type": "string", "const": "started", "title": "State" }, "campaign_revision": { "type": "integer", "title": "Campaign Revision" }, "capacity_operation": { "type": "string", "title": "Capacity Operation" }, "send_price_cents": { "type": "integer", "title": "Send Price Cents" }, "send_budget_cents": { "type": "integer", "title": "Send Budget Cents" }, "started_at": { "type": "number", "title": "Started At" }, "commercial_policy_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Commercial Policy Version" }, "source_refill_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Refill Id" } }, "additionalProperties": false, "type": "object", "required": [ "id", "campaign", "state", "campaign_revision", "capacity_operation", "send_price_cents", "send_budget_cents", "started_at" ], "title": "LaunchResult" }, "LeaseHealthItem": { "properties": { "workspace": { "type": "string", "title": "Workspace" }, "operation": { "type": "string", "title": "Operation" }, "mailbox": { "type": "string", "title": "Mailbox" }, "domain": { "type": "string", "title": "Domain" }, "generation": { "type": "string", "title": "Generation" }, "revision": { "type": "integer", "title": "Revision" }, "daily_capacity": { "type": "integer", "title": "Daily Capacity" }, "started_at": { "type": "number", "title": "Started At" }, "ended_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ended At" }, "state": { "type": "string", "enum": [ "current", "historical" ], "title": "State" }, "history_before_started_at": { "type": "string", "enum": [ "known_absent", "unknown" ], "title": "History Before Started At" }, "transition": { "$ref": "#/components/schemas/LeaseTransition" }, "inbound": { "$ref": "#/components/schemas/LeaseInbound" }, "placement_samples": { "items": { "$ref": "#/components/schemas/LeasePlacementSample" }, "type": "array", "title": "Placement Samples" } }, "additionalProperties": false, "type": "object", "required": [ "workspace", "operation", "mailbox", "domain", "generation", "revision", "daily_capacity", "started_at", "ended_at", "state", "history_before_started_at", "transition", "inbound", "placement_samples" ], "title": "LeaseHealthItem" }, "LeaseHealthPage": { "properties": { "items": { "items": { "$ref": "#/components/schemas/LeaseHealthItem" }, "type": "array", "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "definition": { "type": "string", "const": "lease-health-v1", "title": "Definition" }, "workspace": { "type": "string", "title": "Workspace" }, "observed_at": { "type": "number", "title": "Observed At" }, "coverage": { "type": "string", "const": "local_proven_tenancy_intervals_and_sender_sliced_samples", "title": "Coverage" }, "placement_semantics": { "type": "string", "const": "advisory_sample_not_delivery_guarantee_or_replacement_authority", "title": "Placement Semantics" } }, "additionalProperties": false, "type": "object", "required": [ "items", "next_cursor", "definition", "workspace", "observed_at", "coverage", "placement_semantics" ], "title": "LeaseHealthPage" }, "LeaseInbound": { "properties": { "observed_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Observed At" }, "success_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Success At" }, "error": { "type": "string", "title": "Error" } }, "additionalProperties": false, "type": "object", "required": [ "observed_at", "success_at", "error" ], "title": "LeaseInbound" }, "LeasePlacementSample": { "properties": { "id": { "type": "string", "title": "Id" }, "source": { "type": "string", "title": "Source" }, "test_code": { "type": "string", "title": "Test Code" }, "state": { "type": "string", "title": "State" }, "created_at": { "type": "number", "title": "Created At" }, "observed_at": { "type": "number", "title": "Observed At" }, "evidence_error": { "type": "string", "title": "Evidence Error" }, "sender": { "anyOf": [ { "$ref": "#/components/schemas/LeasePlacementSender" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "required": [ "id", "source", "test_code", "state", "created_at", "observed_at", "evidence_error", "sender" ], "title": "LeasePlacementSample" }, "LeasePlacementSender": { "properties": { "mailbox": { "type": "string", "title": "Mailbox" }, "business_counts": { "$ref": "#/components/schemas/PlacementCounts" }, "providers": { "anyOf": [ { "additionalProperties": { "$ref": "#/components/schemas/PlacementCounts" }, "type": "object" }, { "$ref": "#/components/schemas/HistoricalPlacementProviders" } ], "title": "Providers" }, "measurement": { "type": "string", "title": "Measurement" }, "content_applicability": { "type": "string", "title": "Content Applicability" }, "send_attribution": { "type": "string", "const": "unknown", "title": "Send Attribution" } }, "additionalProperties": false, "type": "object", "required": [ "mailbox", "business_counts", "providers", "measurement", "content_applicability", "send_attribution" ], "title": "LeasePlacementSender" }, "LeaseTransition": { "properties": { "started_by": { "type": "string", "title": "Started By" }, "ended_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ended By" } }, "additionalProperties": false, "type": "object", "required": [ "started_by", "ended_by" ], "title": "LeaseTransition" }, "LedgerEntry": { "properties": { "event_id": { "type": "string", "title": "Event Id" }, "kind": { "type": "string", "title": "Kind" }, "amount": { "type": "integer", "title": "Amount" }, "created_at": { "type": "number", "title": "Created At" } }, "additionalProperties": false, "type": "object", "required": [ "event_id", "kind", "amount", "created_at" ], "title": "LedgerEntry" }, "LedgerItem": { "properties": { "reference": { "type": "string", "title": "Reference" }, "kind": { "type": "string", "enum": [ "funding", "order", "reversal", "promotion" ], "title": "Kind" }, "amount_minor": { "type": "integer", "title": "Amount Minor" }, "order_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Id" }, "created_at": { "type": "string", "title": "Created At" } }, "additionalProperties": false, "type": "object", "required": [ "reference", "kind", "amount_minor", "order_id", "created_at" ], "title": "LedgerItem" }, "LedgerPage": { "properties": { "items": { "items": { "$ref": "#/components/schemas/LedgerEntry" }, "type": "array", "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "additionalProperties": false, "type": "object", "required": [ "items", "next_cursor" ], "title": "LedgerPage" }, "LegacyFundingEntry": { "properties": { "id": { "type": "string", "title": "Id" }, "state": { "type": "string", "title": "State" }, "created_at": { "type": "number", "title": "Created At" }, "completed_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Completed At" }, "submitted_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Submitted At" }, "amount_cents": { "type": "integer", "title": "Amount Cents" }, "method": { "type": "string", "title": "Method" }, "revision": { "type": "integer", "title": "Revision" }, "automatic": { "type": "boolean", "title": "Automatic" }, "consent_revision": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Consent Revision" }, "funding_inputs": { "anyOf": [ { "$ref": "#/components/schemas/LegacyFundingPreview" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "required": [ "id", "state", "created_at", "completed_at", "submitted_at", "amount_cents", "method", "revision", "automatic", "consent_revision", "funding_inputs" ], "title": "LegacyFundingEntry" }, "LegacyFundingHistory": { "properties": { "items": { "items": { "$ref": "#/components/schemas/LegacyFundingEntry" }, "type": "array", "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "additionalProperties": false, "type": "object", "required": [ "items", "next_cursor" ], "title": "LegacyFundingHistory" }, "LegacyFundingPreview": { "properties": { "spendable_cents": { "type": "integer", "title": "Spendable Cents" }, "renewal_cents": { "type": "integer", "title": "Renewal Cents" }, "amount_cents": { "type": "integer", "title": "Amount Cents" }, "policy": { "type": "string", "title": "Policy" } }, "additionalProperties": false, "type": "object", "required": [ "spendable_cents", "renewal_cents", "amount_cents", "policy" ], "title": "LegacyFundingPreview" }, "LegacyFundingResult": { "properties": { "id": { "type": "string", "title": "Id" }, "status": { "type": "string", "title": "Status" }, "amount_cents": { "type": "integer", "title": "Amount Cents" }, "method": { "type": "string", "title": "Method" }, "client_secret": { "type": "string", "title": "Client Secret", "description": "Only returned for an authorized confirmation requiring provider interaction." } }, "additionalProperties": false, "type": "object", "required": [ "id", "status", "amount_cents" ], "title": "LegacyFundingResult" }, "LegacySendingPolicyReceipt": { "properties": { "consumer_id": { "type": "string", "title": "Consumer Id" }, "revision": { "type": "integer", "title": "Revision" }, "slow_ramp": { "type": "boolean", "title": "Slow Ramp" }, "mailbox_daily_limit": { "type": "integer", "enum": [ 7, 15 ], "title": "Mailbox Daily Limit" }, "operation": { "type": "string", "title": "Operation" }, "kind": { "type": "string", "const": "sending_policy", "title": "Kind" }, "recorded_at": { "type": "string", "title": "Recorded At" } }, "additionalProperties": false, "type": "object", "required": [ "consumer_id", "revision", "slow_ramp", "mailbox_daily_limit", "operation", "kind", "recorded_at" ], "title": "LegacySendingPolicyReceipt" }, "ListCampaign": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "state": { "type": "string", "title": "State" }, "archived": { "type": "boolean", "title": "Archived" } }, "type": "object", "required": [ "id", "name", "state", "archived" ], "title": "ListCampaign" }, "ListCampaigns": { "properties": { "total": { "type": "integer", "title": "Total" }, "items": { "items": { "$ref": "#/components/schemas/ListCampaign" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "total", "items" ], "title": "ListCampaigns" }, "ListCreate": { "properties": { "name": { "type": "string", "maxLength": 200, "minLength": 1, "title": "Name" }, "entity_type": { "type": "string", "enum": [ "person", "company" ], "title": "Entity Type" } }, "additionalProperties": false, "type": "object", "required": [ "name", "entity_type" ], "title": "ListCreate" }, "ListEdit": { "properties": { "expected_revision": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Expected Revision" }, "state": { "anyOf": [ { "type": "string", "enum": [ "active", "archived" ] }, { "type": "null" } ], "title": "State" }, "name": { "anyOf": [ { "type": "string", "maxLength": 200, "minLength": 1 }, { "type": "null" } ], "title": "Name" } }, "additionalProperties": false, "type": "object", "required": [ "expected_revision" ], "title": "ListEdit" }, "ListView": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "entity_type": { "type": "string", "enum": [ "person", "company" ], "title": "Entity Type" }, "state": { "type": "string", "enum": [ "active", "archived" ], "title": "State" }, "revision": { "type": "integer", "title": "Revision" }, "membership_revision": { "type": "integer", "title": "Membership Revision" }, "member_count": { "type": "integer", "title": "Member Count" }, "created_at": { "type": "string", "title": "Created At" }, "updated_at": { "type": "string", "title": "Updated At" }, "campaigns": { "anyOf": [ { "$ref": "#/components/schemas/ListCampaigns" }, { "type": "null" } ] } }, "type": "object", "required": [ "id", "name", "entity_type", "state", "revision", "membership_revision", "member_count", "created_at", "updated_at" ], "title": "ListView" }, "LookupResult_CompanyPreview_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/CompanyPreview" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "items" ], "title": "LookupResult[CompanyPreview]" }, "LookupResult_CompanyView_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/CompanyView" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "items" ], "title": "LookupResult[CompanyView]" }, "LookupResult_PersonPreview_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/PersonPreview" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "items" ], "title": "LookupResult[PersonPreview]" }, "LookupResult_PersonView_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/PersonView" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "items" ], "title": "LookupResult[PersonView]" }, "MailboxObservation": { "properties": { "mailbox": { "type": "string", "title": "Mailbox" }, "generation": { "type": "string", "title": "Generation" }, "domain": { "type": "string", "title": "Domain" }, "ramp_day": { "type": "integer", "minimum": 0.0, "title": "Ramp Day" }, "started_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Started At" }, "provenance": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provenance" }, "introduction_started_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Introduction Started At" }, "introduction_provenance": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Introduction Provenance" }, "effective_daily_limit": { "type": "integer", "maximum": 15000.0, "minimum": 0.0, "title": "Effective Daily Limit" }, "committed_units": { "type": "integer", "minimum": 0.0, "title": "Committed Units" }, "remaining_units": { "type": "integer", "maximum": 15000.0, "minimum": 0.0, "title": "Remaining Units" }, "reason": { "type": "string", "title": "Reason" }, "next_admission_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Next Admission At" } }, "type": "object", "required": [ "mailbox", "generation", "domain", "ramp_day", "started_at", "provenance", "introduction_started_at", "introduction_provenance", "effective_daily_limit", "committed_units", "remaining_units", "reason", "next_admission_at" ], "title": "MailboxObservation" }, "MailboxPlan": { "properties": { "retained": { "type": "integer", "title": "Retained" }, "available": { "type": "integer", "title": "Available" }, "purchase": { "type": "integer", "title": "Purchase" }, "assign_purchased": { "type": "integer", "title": "Assign Purchased" }, "spare_purchased": { "type": "integer", "title": "Spare Purchased" }, "release": { "type": "integer", "title": "Release" }, "purchase_domains": { "type": "integer", "title": "Purchase Domains" } }, "additionalProperties": false, "type": "object", "required": [ "retained", "available", "purchase", "assign_purchased", "spare_purchased", "release", "purchase_domains" ], "title": "MailboxPlan" }, "MailboxRecovery": { "properties": { "replacement_needed": { "type": "integer", "title": "Replacement Needed" }, "restricted": { "type": "integer", "title": "Restricted" }, "limited": { "type": "boolean", "title": "Limited" }, "pending": { "type": "boolean", "title": "Pending" }, "error": { "type": "string", "title": "Error" }, "source_last_polled_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Source Last Polled At" }, "source_poll_failed": { "type": "boolean", "title": "Source Poll Failed" } }, "additionalProperties": false, "type": "object", "required": [ "replacement_needed", "restricted", "limited", "pending", "error", "source_last_polled_at", "source_poll_failed" ], "title": "MailboxRecovery" }, "MandateChange": { "properties": { "revision": { "type": "integer", "minimum": 0.0, "title": "Revision" }, "enabled": { "type": "boolean", "title": "Enabled" }, "policy_id": { "type": "string", "enum": [ "data-autopay-test-v1", "data-autopay-live-v1" ], "title": "Policy Id" }, "billing_revision": { "type": "integer", "minimum": 0.0, "title": "Billing Revision" }, "low_water_minor": { "type": "integer", "maximum": 100000.0, "minimum": 0.0, "title": "Low Water Minor" }, "refill_minor": { "type": "integer", "maximum": 100000.0, "minimum": 500.0, "title": "Refill Minor" }, "max_charge_minor": { "type": "integer", "maximum": 100000.0, "minimum": 500.0, "title": "Max Charge Minor" }, "max_month_minor": { "type": "integer", "maximum": 10000000.0, "minimum": 500.0, "title": "Max Month Minor" }, "expires_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Expires At" } }, "additionalProperties": false, "type": "object", "required": [ "revision", "enabled", "policy_id", "billing_revision", "low_water_minor", "refill_minor", "max_charge_minor", "max_month_minor" ], "title": "MandateChange" }, "MandateView": { "properties": { "available": { "type": "boolean", "title": "Available" }, "policy_id": { "anyOf": [ { "type": "string", "enum": [ "data-autopay-test-v1", "data-autopay-live-v1" ] }, { "type": "null" } ], "title": "Policy Id" }, "revision": { "type": "integer", "title": "Revision" }, "enabled": { "type": "boolean", "title": "Enabled" }, "terms": { "anyOf": [ { "$ref": "#/components/schemas/MandateChange" }, { "type": "null" } ] }, "updated_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Updated At" }, "operation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Operation" }, "error": { "type": "string", "title": "Error", "default": "" }, "blocker": { "type": "string", "title": "Blocker", "description": "Current local authority/configuration blocker, separate from the last worker error. Empty is not a promise of payment or evidence of provider health.", "default": "" }, "next_attempt": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Next Attempt" }, "defaults": { "anyOf": [ { "$ref": "#/components/schemas/MandateChange" }, { "type": "null" } ] }, "readiness": { "$ref": "#/components/schemas/FundingReadiness" } }, "additionalProperties": false, "type": "object", "required": [ "available", "policy_id", "revision", "enabled", "readiness" ], "title": "MandateView" }, "ManifestConfig": { "properties": { "entity_type": { "anyOf": [ { "type": "string", "enum": [ "person", "company" ] }, { "type": "null" } ], "title": "Entity Type" }, "kind": { "type": "string", "enum": [ "records", "identifiers", "ids", "suppressions", "contact_history", "source_records", "source_versions", "export_rows" ], "title": "Kind" }, "defaults": { "anyOf": [ { "$ref": "#/components/schemas/SuppressionDefaults" }, { "type": "null" } ] }, "history_source": { "anyOf": [ { "type": "string", "maxLength": 200, "minLength": 1, "pattern": "^[^\\x00-\\x1f\\x7f]+$" }, { "type": "null" } ], "title": "History Source", "description": "Optional immutable source label for contact-history rows without their own source column." }, "format": { "type": "string", "enum": [ "ndjson", "csv" ], "title": "Format", "default": "ndjson" }, "columns": { "additionalProperties": { "type": "string" }, "type": "object", "maxProperties": 200, "title": "Columns" }, "max_rows": { "type": "integer", "maximum": 5000000.0, "minimum": 1.0, "title": "Max Rows" }, "max_bytes": { "type": "integer", "maximum": 8589934592.0, "minimum": 1.0, "title": "Max Bytes" } }, "additionalProperties": false, "type": "object", "required": [ "kind", "max_rows", "max_bytes" ], "title": "ManifestConfig" }, "MaterializationStatus": { "properties": { "state": { "type": "string", "enum": [ "not_started", "pending", "complete" ], "title": "State" }, "next_attempt": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Next Attempt" }, "blocker": { "type": "string", "title": "Blocker" } }, "additionalProperties": false, "type": "object", "required": [ "state", "next_attempt", "blocker" ], "title": "MaterializationStatus" }, "MembershipChange": { "properties": { "expected_membership_revision": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Expected Membership Revision" }, "action": { "type": "string", "enum": [ "add", "remove" ], "title": "Action" }, "ids": { "items": { "type": "string", "pattern": "^[a-f0-9]{32}$" }, "type": "array", "maxItems": 200, "minItems": 1, "title": "Ids" } }, "additionalProperties": false, "type": "object", "required": [ "expected_membership_revision", "action", "ids" ], "title": "MembershipChange" }, "MembershipCounts": { "properties": { "added": { "type": "integer", "title": "Added", "default": 0 }, "already_present": { "type": "integer", "title": "Already Present", "default": 0 }, "removed": { "type": "integer", "title": "Removed", "default": 0 }, "not_present": { "type": "integer", "title": "Not Present", "default": 0 } }, "type": "object", "title": "MembershipCounts" }, "MessageAddress": { "properties": { "name": { "type": "string", "maxLength": 200, "title": "Name" }, "email": { "type": "string", "maxLength": 254, "title": "Email" } }, "additionalProperties": false, "type": "object", "required": [ "name", "email" ], "title": "MessageAddress" }, "MessageAttachment": { "properties": { "filename": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filename" }, "content_type": { "type": "string", "title": "Content Type" }, "size_bytes": { "type": "integer", "title": "Size Bytes" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Id" }, "sha256": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sha256" }, "original": { "type": "boolean", "title": "Original", "default": false } }, "additionalProperties": false, "type": "object", "required": [ "filename", "content_type", "size_bytes" ], "title": "MessageAttachment" }, "MessageCopy": { "properties": { "subject": { "type": "string", "title": "Subject" }, "body": { "type": "string", "title": "Body" } }, "type": "object", "required": [ "subject", "body" ], "title": "MessageCopy" }, "MessageParticipants": { "properties": { "subject": { "type": "string", "maxLength": 500, "title": "Subject" }, "message_id": { "type": "string", "maxLength": 1000, "title": "Message Id" }, "in_reply_to": { "type": "string", "maxLength": 2048, "title": "In Reply To" }, "references": { "items": { "type": "string" }, "type": "array", "maxItems": 100, "title": "References" }, "provenance": { "type": "string", "const": "original_mime", "title": "Provenance" }, "from": { "items": { "$ref": "#/components/schemas/MessageAddress" }, "type": "array", "maxItems": 100, "title": "From" }, "reply_to": { "items": { "$ref": "#/components/schemas/MessageAddress" }, "type": "array", "maxItems": 100, "title": "Reply To" }, "to": { "items": { "$ref": "#/components/schemas/MessageAddress" }, "type": "array", "maxItems": 100, "title": "To" }, "cc": { "items": { "$ref": "#/components/schemas/MessageAddress" }, "type": "array", "maxItems": 100, "title": "Cc" }, "mailbox": { "type": "string", "title": "Mailbox" } }, "additionalProperties": false, "type": "object", "required": [ "subject", "message_id", "in_reply_to", "references", "provenance", "from", "reply_to", "to", "cc", "mailbox" ], "title": "MessageParticipants" }, "NameMapping": { "properties": { "source_field": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Source Field" }, "target_field": { "type": "string", "maxLength": 128, "minLength": 1, "pattern": "^[a-zA-Z_][a-zA-Z_0-9]*$", "title": "Target Field" }, "source_kind": { "type": "string", "enum": [ "full_name", "first_name" ], "title": "Source Kind", "default": "full_name" } }, "additionalProperties": false, "type": "object", "required": [ "source_field", "target_field" ], "title": "NameMapping" }, "Nested-Input": { "properties": { "type": { "type": "string", "const": "nested", "title": "Type" }, "filters": { "additionalProperties": { "oneOf": [ { "$ref": "#/components/schemas/Keywords" }, { "$ref": "#/components/schemas/Picklist" }, { "$ref": "#/components/schemas/Presence" }, { "$ref": "#/components/schemas/Range" }, { "$ref": "#/components/schemas/Nested-Input" } ], "discriminator": { "propertyName": "type", "mapping": { "exists": "#/components/schemas/Presence", "keyword_group": "#/components/schemas/Keywords", "nested": "#/components/schemas/Nested-Input", "picklist": "#/components/schemas/Picklist", "range": "#/components/schemas/Range" } } }, "type": "object", "maxProperties": 20, "minProperties": 1, "title": "Filters" }, "exclude": { "type": "boolean", "title": "Exclude", "default": false } }, "additionalProperties": false, "type": "object", "required": [ "type", "filters" ], "title": "Nested" }, "Nested-Output": { "properties": { "type": { "type": "string", "const": "nested", "title": "Type" }, "filters": { "additionalProperties": { "oneOf": [ { "$ref": "#/components/schemas/Keywords" }, { "$ref": "#/components/schemas/Picklist" }, { "$ref": "#/components/schemas/Presence" }, { "$ref": "#/components/schemas/Range" }, { "$ref": "#/components/schemas/Nested-Output" } ], "discriminator": { "propertyName": "type", "mapping": { "exists": "#/components/schemas/Presence", "keyword_group": "#/components/schemas/Keywords", "nested": "#/components/schemas/Nested-Output", "picklist": "#/components/schemas/Picklist", "range": "#/components/schemas/Range" } } }, "type": "object", "maxProperties": 20, "minProperties": 1, "title": "Filters" }, "exclude": { "type": "boolean", "title": "Exclude", "default": false } }, "additionalProperties": false, "type": "object", "required": [ "type", "filters" ], "title": "Nested" }, "NestedFieldDefinition": { "properties": { "operators": { "items": { "type": "string" }, "type": "array", "title": "Operators" } }, "type": "object", "required": [ "operators" ], "title": "NestedFieldDefinition" }, "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" }, "Observation": { "properties": { "consumer_id": { "type": "string", "title": "Consumer Id" }, "revision": { "type": "integer", "minimum": 0.0, "title": "Revision" }, "ramp_enforced": { "type": "boolean", "const": true, "title": "Ramp Enforced" }, "ramp_policy_version": { "type": "string", "const": "ramp-v1", "title": "Ramp Policy Version" }, "observed_at": { "type": "string", "format": "date-time", "title": "Observed At" }, "valid_until": { "type": "string", "format": "date-time", "title": "Valid Until" }, "quota_day": { "type": "string", "title": "Quota Day" }, "quota_timezone": { "type": "string", "title": "Quota Timezone" }, "roster_fingerprint": { "type": "string", "pattern": "^[0-9a-f]{64}$", "title": "Roster Fingerprint" }, "nominal_daily_limit": { "type": "integer", "maximum": 30000.0, "minimum": 0.0, "title": "Nominal Daily Limit" }, "effective_daily_limit": { "type": "integer", "maximum": 30000.0, "minimum": 0.0, "title": "Effective Daily Limit" }, "remaining_units": { "type": "integer", "maximum": 30000.0, "minimum": 0.0, "title": "Remaining Units" }, "committed_units": { "type": "integer", "minimum": 0.0, "title": "Committed Units" }, "items": { "items": { "$ref": "#/components/schemas/MailboxObservation" }, "type": "array", "maxItems": 1000, "title": "Items" } }, "type": "object", "required": [ "consumer_id", "revision", "ramp_enforced", "ramp_policy_version", "observed_at", "valid_until", "quota_day", "quota_timezone", "roster_fingerprint", "nominal_daily_limit", "effective_daily_limit", "remaining_units", "committed_units", "items" ], "title": "Observation" }, "Operation": { "properties": { "id": { "type": "string", "title": "Id" }, "kind": { "type": "string", "enum": [ "people.create", "people.edit", "companies.create", "companies.edit", "lists.create", "lists.edit", "lists.membership", "people.save_source", "companies.save_source", "people.check_source", "companies.check_source", "people.refresh_preview", "companies.refresh_preview", "searches.create", "searches.edit", "search_sets.create", "search_sets.edit", "data_jobs.resume", "data_jobs.confirm" ], "title": "Kind" }, "resource_id": { "type": "string", "title": "Resource Id" }, "state": { "type": "string", "const": "completed", "title": "State", "default": "completed" }, "revision": { "type": "integer", "title": "Revision" }, "membership_revision": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Membership Revision" }, "counts": { "anyOf": [ { "$ref": "#/components/schemas/MembershipCounts" }, { "type": "null" } ] }, "changed_ids": { "anyOf": [ { "items": { "type": "string", "pattern": "^[a-f0-9]{32}$" }, "type": "array", "maxItems": 200 }, { "type": "null" } ], "title": "Changed Ids" }, "source_check_revision": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Source Check Revision" }, "freshness": { "anyOf": [ { "type": "string", "enum": [ "current", "update_available", "unavailable" ] }, { "type": "null" } ], "title": "Freshness" }, "source_comparison": { "anyOf": [ { "$ref": "#/components/schemas/SourceComparison" }, { "type": "null" } ] }, "created_at": { "type": "string", "title": "Created At" } }, "type": "object", "required": [ "id", "kind", "resource_id", "revision", "created_at" ], "title": "Operation" }, "OrderResult": { "properties": { "record_id": { "type": "string", "title": "Record Id" }, "version_id": { "type": "string", "title": "Version Id" }, "outcome": { "type": "string", "enum": [ "newly_granted", "already_owned", "missing_email", "missing_licensed_data", "invalid_contact" ], "title": "Outcome" }, "amount_minor": { "type": "integer", "title": "Amount Minor" }, "snapshot": { "anyOf": [ { "$ref": "#/components/schemas/OwnedSnapshot" }, { "type": "null" } ] } }, "type": "object", "required": [ "record_id", "version_id", "outcome", "amount_minor" ], "title": "OrderResult" }, "OrderSummary": { "properties": { "id": { "type": "string", "title": "Id" }, "state": { "type": "string", "enum": [ "awaiting_funds", "completed", "cancelled" ], "title": "State" }, "created_at": { "type": "string", "title": "Created At" }, "completed_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Completed At" }, "currency": { "type": "string", "const": "usd", "title": "Currency", "default": "usd" }, "amount_minor": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Amount Minor" } }, "type": "object", "required": [ "id", "state", "created_at", "completed_at" ], "title": "OrderSummary" }, "OrderTerms": { "properties": { "policy_id": { "type": "string", "maxLength": 100, "minLength": 1, "title": "Policy Id" }, "currency": { "type": "string", "const": "usd", "title": "Currency", "default": "usd" }, "max_amount_minor": { "type": "integer", "maximum": 10000000.0, "minimum": 0.0, "title": "Max Amount Minor" } }, "additionalProperties": false, "type": "object", "required": [ "policy_id", "max_amount_minor" ], "title": "OrderTerms" }, "OrderView": { "properties": { "id": { "type": "string", "title": "Id" }, "state": { "type": "string", "enum": [ "awaiting_funds", "completed", "cancelled" ], "title": "State" }, "policy": { "$ref": "#/components/schemas/DataPolicy" }, "currency": { "type": "string", "const": "usd", "title": "Currency" }, "max_amount_minor": { "type": "integer", "title": "Max Amount Minor" }, "amount_minor": { "type": "integer", "title": "Amount Minor" }, "funding_required_minor": { "type": "integer", "title": "Funding Required Minor" }, "automatic_funding": { "type": "boolean", "title": "Automatic Funding", "default": false }, "funding_error": { "type": "string", "title": "Funding Error", "default": "" }, "items": { "items": { "$ref": "#/components/schemas/OrderResult" }, "type": "array", "title": "Items" }, "matches": { "anyOf": [ { "items": { "$ref": "#/components/schemas/EnrichmentMatch" }, "type": "array" }, { "type": "null" } ], "title": "Matches" }, "created_at": { "type": "string", "title": "Created At" }, "completed_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Completed At" } }, "type": "object", "required": [ "id", "state", "policy", "currency", "max_amount_minor", "amount_minor", "funding_required_minor", "items", "created_at", "completed_at" ], "title": "OrderView" }, "OutboundMessage": { "properties": { "seq": { "type": "integer", "title": "Seq" }, "direction": { "type": "string", "enum": [ "in", "out" ], "title": "Direction" }, "authorship": { "type": "string", "enum": [ "external", "campaign", "human", "automation" ], "title": "Authorship" }, "occurred_at": { "type": "number", "title": "Occurred At" }, "job_id": { "type": "string", "title": "Job Id" }, "submitted_by": { "type": "string", "title": "Submitted By" }, "message_id": { "type": "string", "title": "Message Id" }, "state": { "type": "string", "enum": [ "queued", "reserved", "dispatching", "accepted", "not_accepted", "unknown", "cancelled" ], "title": "State" }, "error": { "type": "string", "title": "Error" }, "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subject" }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content" }, "participants": { "$ref": "#/components/schemas/MessageParticipants" }, "has_html": { "type": "boolean", "title": "Has Html" }, "attachments": { "items": { "$ref": "#/components/schemas/MessageAttachment" }, "type": "array", "title": "Attachments" } }, "additionalProperties": false, "type": "object", "required": [ "seq", "direction", "authorship", "occurred_at", "job_id", "submitted_by", "message_id", "state", "error", "subject", "content" ], "title": "OutboundMessage" }, "OwnedData": { "properties": { "grant_id": { "type": "string", "title": "Grant Id" }, "version_id": { "type": "string", "title": "Version Id" }, "fields": { "additionalProperties": { "$ref": "#/components/schemas/JsonValue" }, "type": "object", "title": "Fields", "description": "Immutable recorded fields. New grants use the current dataset registry; historical originals retain their original keys and values." }, "granted_at": { "type": "string", "title": "Granted At" }, "freshness": { "type": "string", "enum": [ "current", "update_available", "unavailable" ], "title": "Freshness" }, "checked_at": { "type": "string", "title": "Checked At" } }, "type": "object", "required": [ "grant_id", "version_id", "fields", "granted_at", "freshness", "checked_at" ], "title": "OwnedData" }, "OwnedSnapshot": { "properties": { "grant_id": { "type": "string", "title": "Grant Id" }, "version_id": { "type": "string", "title": "Version Id" }, "fields": { "additionalProperties": { "$ref": "#/components/schemas/JsonValue" }, "type": "object", "title": "Fields", "description": "Immutable recorded fields. New grants use the current dataset registry; historical originals retain their original keys and values." }, "granted_at": { "type": "string", "title": "Granted At" } }, "type": "object", "required": [ "grant_id", "version_id", "fields", "granted_at" ], "title": "OwnedSnapshot" }, "OwnerTestCosts": { "properties": { "acquisition_cents": { "type": "integer", "title": "Acquisition Cents" }, "mailbox_monthly_cents": { "type": "integer", "title": "Mailbox Monthly Cents" }, "domain_renewal_cents": { "type": "null", "title": "Domain Renewal Cents" } }, "additionalProperties": false, "type": "object", "required": [ "acquisition_cents", "mailbox_monthly_cents", "domain_renewal_cents" ], "title": "OwnerTestCosts" }, "Page_CheckRoundView_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/CheckRoundView" }, "type": "array", "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "type": "object", "required": [ "items", "next_cursor" ], "title": "Page[CheckRoundView]" }, "Page_CompanyView_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/CompanyView" }, "type": "array", "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "type": "object", "required": [ "items", "next_cursor" ], "title": "Page[CompanyView]" }, "Page_ContactCampaign_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ContactCampaign" }, "type": "array", "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "type": "object", "required": [ "items", "next_cursor" ], "title": "Page[ContactCampaign]" }, "Page_DomainSetView_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/DomainSetView" }, "type": "array", "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "type": "object", "required": [ "items", "next_cursor" ], "title": "Page[DomainSetView]" }, "Page_ImportView_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ImportView" }, "type": "array", "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "type": "object", "required": [ "items", "next_cursor" ], "title": "Page[ImportView]" }, "Page_JobView_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/JobView" }, "type": "array", "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "type": "object", "required": [ "items", "next_cursor" ], "title": "Page[JobView]" }, "Page_ListCampaign_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ListCampaign" }, "type": "array", "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "type": "object", "required": [ "items", "next_cursor" ], "title": "Page[ListCampaign]" }, "Page_ListView_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ListView" }, "type": "array", "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "type": "object", "required": [ "items", "next_cursor" ], "title": "Page[ListView]" }, "Page_OrderSummary_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/OrderSummary" }, "type": "array", "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "type": "object", "required": [ "items", "next_cursor" ], "title": "Page[OrderSummary]" }, "Page_PersonView_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/PersonView" }, "type": "array", "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "type": "object", "required": [ "items", "next_cursor" ], "title": "Page[PersonView]" }, "Page_SavedSearchView_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/SavedSearchView" }, "type": "array", "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "type": "object", "required": [ "items", "next_cursor" ], "title": "Page[SavedSearchView]" }, "Page_SelectionView_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/SelectionView" }, "type": "array", "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "type": "object", "required": [ "items", "next_cursor" ], "title": "Page[SelectionView]" }, "Page_Union_PersonView__CompanyView__": { "properties": { "items": { "items": { "anyOf": [ { "$ref": "#/components/schemas/PersonView" }, { "$ref": "#/components/schemas/CompanyView" } ] }, "type": "array", "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "type": "object", "required": [ "items", "next_cursor" ], "title": "Page[Union[PersonView, CompanyView]]" }, "PaidCapacityTerm": { "properties": { "daily_sends": { "type": "integer", "title": "Daily Sends" }, "term_cents": { "type": "integer", "title": "Term Cents" }, "starts_at": { "type": "string", "title": "Starts At" }, "ends_at": { "type": "string", "title": "Ends At" } }, "additionalProperties": false, "type": "object", "required": [ "daily_sends", "term_cents", "starts_at", "ends_at" ], "title": "PaidCapacityTerm" }, "PendingCapacityExpansion": { "properties": { "id": { "type": "string", "title": "Id" }, "desired_daily_sends": { "type": "integer", "title": "Desired Daily Sends" }, "maximum_additional_cents": { "type": "integer", "title": "Maximum Additional Cents" }, "blocker": { "type": "string", "title": "Blocker" } }, "additionalProperties": false, "type": "object", "required": [ "id", "desired_daily_sends", "maximum_additional_cents", "blocker" ], "title": "PendingCapacityExpansion" }, "PendingCapacityTerm": { "properties": { "operation": { "type": "string", "title": "Operation" }, "effective_at": { "type": "string", "title": "Effective At" }, "lease_until": { "type": "string", "title": "Lease Until" }, "term_cents": { "type": "integer", "title": "Term Cents" }, "state": { "type": "string", "enum": [ "pending", "settled" ], "title": "State" }, "blocker": { "type": "string", "title": "Blocker" }, "allocated_daily_sends": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Allocated Daily Sends" } }, "additionalProperties": false, "type": "object", "required": [ "operation", "effective_at", "lease_until", "term_cents", "state", "blocker", "allocated_daily_sends" ], "title": "PendingCapacityTerm" }, "PersonAvailability": { "properties": { "business_email": { "type": "string", "enum": [ "present", "not_present" ], "title": "Business Email" } }, "additionalProperties": false, "type": "object", "required": [ "business_email" ], "title": "PersonAvailability" }, "PersonData": { "properties": { "UUID": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Person UUID" }, "FIRST_NAME": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "First name" }, "LAST_NAME": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Last name" }, "PHOTO_URL": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Photo URL" }, "COMPANY_NAME": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company name" }, "JOB_TITLE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Job title" }, "COMPANY_LOGO_URL": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company logo URL" }, "PERSONAL_CITY": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "City" }, "PERSONAL_STATE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "State" }, "PERSONAL_COUNTRY": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Country" }, "COMPANY_DOMAIN": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company domain" }, "MIDDLE_NAME": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Middle name" }, "DEPARTMENT": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Department" }, "SENIORITY_LEVEL": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Seniority level" }, "HEADLINE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Headline" }, "SUMMARY": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Summary" }, "SKILLS": { "anyOf": [ { "items": { "type": "string", "maxLength": 65536 }, "type": "array", "maxItems": 1000 }, { "type": "null" } ], "title": "Skills" }, "WORK_EXPERIENCE": { "anyOf": [ { "items": { "$ref": "#/components/schemas/WorkExperience" }, "type": "array", "maxItems": 1000 }, { "type": "null" } ], "title": "Work experience" }, "EDUCATION_HISTORY": { "anyOf": [ { "items": { "$ref": "#/components/schemas/EducationHistory" }, "type": "array", "maxItems": 1000 }, { "type": "null" } ], "title": "Education history" }, "POSTS": { "anyOf": [ { "items": { "additionalProperties": { "$ref": "#/components/schemas/JsonValue" }, "type": "object" }, "type": "array", "maxItems": 1000 }, { "type": "null" } ], "title": "Posts" }, "CURRENT_BUSINESS_EMAIL": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Current business email" }, "CURRENT_BUSINESS_EMAIL_VALIDATION_STATUS": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Business email validation status" }, "CURRENT_BUSINESS_EMAIL_VALIDATION_DATE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Business email validation date" }, "EMAILS": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "items": { "type": "string", "maxLength": 65536 }, "type": "array", "maxItems": 1000 }, { "type": "null" } ], "title": "Emails" }, "PHONES": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "items": { "type": "string", "maxLength": 65536 }, "type": "array", "maxItems": 1000 }, { "type": "null" } ], "title": "Phones" }, "MOBILE_PHONE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Mobile phone" }, "MOBILE_PHONE_VALIDATION_STATUS": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Mobile phone validation status" }, "LINKEDIN_URL": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "LinkedIn URL" }, "PERSONAL_ADDRESS": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Address" }, "PERSONAL_ZIP": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Postal code" }, "LAST_UPDATED": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Last updated" }, "COMPANY_DESCRIPTION": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company description" }, "COMPANY_INDUSTRY": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company industry" }, "COMPANY_REVENUE_RANGE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Revenue range" }, "COMPANY_NUM_EMPLOYEE_RANGE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company size" }, "COMPANY_OWNERSHIP": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Ownership" }, "COMPANY_LATEST_FUNDING_STAGE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Latest funding stage" }, "COMPANY_LATEST_FUNDING_ROUND_DATE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Latest funding date" }, "COMPANY_TOTAL_FUNDING": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Total funding" }, "COMPANY_STOCK_EXCHANGE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Stock exchange" }, "COMPANY_TICKER_SYMBOL": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Ticker symbol" }, "COMPANY_STOCK_SYMBOL": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Stock symbol" }, "COMPANY_MARKET_CAPITALIZATION": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Market capitalization" }, "COMPANY_TOTAL_REVENUE": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Total revenue" }, "COMPANY_NUMBER_OF_FOLLOWERS": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Followers" }, "COMPANY_CITY": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company city" }, "COMPANY_STATE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company state" }, "COMPANY_COUNTRY": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company country" }, "COMPANY_COUNTRY_NUMERIC": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Country numeric code" }, "COMPANY_ADDRESS": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company address" }, "COMPANY_ZIP_CODE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company postal code" }, "COMPANY_FOUNDED_YEAR": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Founded year" }, "COMPANY_LINKEDIN_URL": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company LinkedIn URL" }, "COMPANY_FACEBOOK_URL": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company Facebook URL" }, "COMPANY_TWITTER_URL": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company Twitter URL" }, "COMPANY_ANGELLIST_URL": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company AngelList URL" }, "COMPANY_TECHNOLOGIES": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "items": { "type": "string", "maxLength": 65536 }, "type": "array", "maxItems": 1000 }, { "type": "null" } ], "title": "Technologies" }, "COMPANY_RETAIL_LOCATION_COUNT": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Retail locations" } }, "additionalProperties": false, "type": "object", "title": "PersonData" }, "PersonEdit": { "properties": { "expected_revision": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Expected Revision" }, "state": { "anyOf": [ { "type": "string", "enum": [ "active", "archived" ] }, { "type": "null" } ], "title": "State" }, "UUID": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Person UUID" }, "FIRST_NAME": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "First name" }, "LAST_NAME": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Last name" }, "PHOTO_URL": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Photo URL" }, "COMPANY_NAME": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company name" }, "JOB_TITLE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Job title" }, "COMPANY_LOGO_URL": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company logo URL" }, "PERSONAL_CITY": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "City" }, "PERSONAL_STATE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "State" }, "PERSONAL_COUNTRY": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Country" }, "COMPANY_DOMAIN": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company domain" }, "MIDDLE_NAME": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Middle name" }, "DEPARTMENT": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Department" }, "SENIORITY_LEVEL": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Seniority level" }, "HEADLINE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Headline" }, "SUMMARY": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Summary" }, "SKILLS": { "anyOf": [ { "items": { "type": "string", "maxLength": 65536 }, "type": "array", "maxItems": 1000 }, { "type": "null" } ], "title": "Skills" }, "WORK_EXPERIENCE": { "anyOf": [ { "items": { "$ref": "#/components/schemas/WorkExperience" }, "type": "array", "maxItems": 1000 }, { "type": "null" } ], "title": "Work experience" }, "EDUCATION_HISTORY": { "anyOf": [ { "items": { "$ref": "#/components/schemas/EducationHistory" }, "type": "array", "maxItems": 1000 }, { "type": "null" } ], "title": "Education history" }, "POSTS": { "anyOf": [ { "items": { "additionalProperties": { "$ref": "#/components/schemas/JsonValue" }, "type": "object" }, "type": "array", "maxItems": 1000 }, { "type": "null" } ], "title": "Posts" }, "CURRENT_BUSINESS_EMAIL": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Current business email" }, "CURRENT_BUSINESS_EMAIL_VALIDATION_STATUS": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Business email validation status" }, "CURRENT_BUSINESS_EMAIL_VALIDATION_DATE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Business email validation date" }, "EMAILS": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "items": { "type": "string", "maxLength": 65536 }, "type": "array", "maxItems": 1000 }, { "type": "null" } ], "title": "Emails" }, "PHONES": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "items": { "type": "string", "maxLength": 65536 }, "type": "array", "maxItems": 1000 }, { "type": "null" } ], "title": "Phones" }, "MOBILE_PHONE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Mobile phone" }, "MOBILE_PHONE_VALIDATION_STATUS": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Mobile phone validation status" }, "LINKEDIN_URL": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "LinkedIn URL" }, "PERSONAL_ADDRESS": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Address" }, "PERSONAL_ZIP": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Postal code" }, "LAST_UPDATED": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Last updated" }, "COMPANY_DESCRIPTION": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company description" }, "COMPANY_INDUSTRY": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company industry" }, "COMPANY_REVENUE_RANGE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Revenue range" }, "COMPANY_NUM_EMPLOYEE_RANGE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company size" }, "COMPANY_OWNERSHIP": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Ownership" }, "COMPANY_LATEST_FUNDING_STAGE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Latest funding stage" }, "COMPANY_LATEST_FUNDING_ROUND_DATE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Latest funding date" }, "COMPANY_TOTAL_FUNDING": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Total funding" }, "COMPANY_STOCK_EXCHANGE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Stock exchange" }, "COMPANY_TICKER_SYMBOL": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Ticker symbol" }, "COMPANY_STOCK_SYMBOL": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Stock symbol" }, "COMPANY_MARKET_CAPITALIZATION": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Market capitalization" }, "COMPANY_TOTAL_REVENUE": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Total revenue" }, "COMPANY_NUMBER_OF_FOLLOWERS": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Followers" }, "COMPANY_CITY": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company city" }, "COMPANY_STATE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company state" }, "COMPANY_COUNTRY": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company country" }, "COMPANY_COUNTRY_NUMERIC": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Country numeric code" }, "COMPANY_ADDRESS": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company address" }, "COMPANY_ZIP_CODE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company postal code" }, "COMPANY_FOUNDED_YEAR": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Founded year" }, "COMPANY_LINKEDIN_URL": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company LinkedIn URL" }, "COMPANY_FACEBOOK_URL": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company Facebook URL" }, "COMPANY_TWITTER_URL": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company Twitter URL" }, "COMPANY_ANGELLIST_URL": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company AngelList URL" }, "COMPANY_TECHNOLOGIES": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "items": { "type": "string", "maxLength": 65536 }, "type": "array", "maxItems": 1000 }, { "type": "null" } ], "title": "Technologies" }, "COMPANY_RETAIL_LOCATION_COUNT": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Retail locations" }, "company_record_id": { "anyOf": [ { "type": "string", "pattern": "^[a-f0-9]{32}$" }, { "type": "null" } ], "title": "Company Record Id", "description": "Optional workspace company relationship; never the dataset COMPANY_ID." }, "remove_overrides": { "items": { "type": "string", "enum": [ "FIRST_NAME", "LAST_NAME", "PHOTO_URL", "COMPANY_NAME", "JOB_TITLE", "COMPANY_LOGO_URL", "PERSONAL_CITY", "PERSONAL_STATE", "PERSONAL_COUNTRY", "COMPANY_DOMAIN", "MIDDLE_NAME", "DEPARTMENT", "SENIORITY_LEVEL", "HEADLINE", "SUMMARY", "SKILLS", "WORK_EXPERIENCE", "EDUCATION_HISTORY", "POSTS", "CURRENT_BUSINESS_EMAIL", "CURRENT_BUSINESS_EMAIL_VALIDATION_STATUS", "CURRENT_BUSINESS_EMAIL_VALIDATION_DATE", "EMAILS", "PHONES", "MOBILE_PHONE", "MOBILE_PHONE_VALIDATION_STATUS", "LINKEDIN_URL", "PERSONAL_ADDRESS", "PERSONAL_ZIP", "LAST_UPDATED", "COMPANY_DESCRIPTION", "COMPANY_INDUSTRY", "COMPANY_REVENUE_RANGE", "COMPANY_NUM_EMPLOYEE_RANGE", "COMPANY_OWNERSHIP", "COMPANY_LATEST_FUNDING_STAGE", "COMPANY_LATEST_FUNDING_ROUND_DATE", "COMPANY_TOTAL_FUNDING", "COMPANY_STOCK_EXCHANGE", "COMPANY_TICKER_SYMBOL", "COMPANY_STOCK_SYMBOL", "COMPANY_MARKET_CAPITALIZATION", "COMPANY_TOTAL_REVENUE", "COMPANY_NUMBER_OF_FOLLOWERS", "COMPANY_CITY", "COMPANY_STATE", "COMPANY_COUNTRY", "COMPANY_COUNTRY_NUMERIC", "COMPANY_ADDRESS", "COMPANY_ZIP_CODE", "COMPANY_FOUNDED_YEAR", "COMPANY_LINKEDIN_URL", "COMPANY_FACEBOOK_URL", "COMPANY_TWITTER_URL", "COMPANY_ANGELLIST_URL", "COMPANY_TECHNOLOGIES", "COMPANY_RETAIL_LOCATION_COUNT" ] }, "type": "array", "maxItems": 64, "minItems": 1, "title": "Remove Overrides", "description": "Remove selected provided overrides and use the selected owned snapshot values. Requires a catalogue-backed licensed record; omission preserves overrides, null still masks a value. No purchase or source refresh." } }, "additionalProperties": false, "type": "object", "required": [ "expected_revision" ], "title": "PersonEdit" }, "PersonFields": { "properties": { "UUID": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Person UUID" }, "FIRST_NAME": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "First name" }, "LAST_NAME": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Last name" }, "PHOTO_URL": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Photo URL" }, "COMPANY_NAME": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company name" }, "JOB_TITLE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Job title" }, "COMPANY_LOGO_URL": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company logo URL" }, "PERSONAL_CITY": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "City" }, "PERSONAL_STATE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "State" }, "PERSONAL_COUNTRY": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Country" }, "COMPANY_DOMAIN": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company domain" }, "MIDDLE_NAME": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Middle name" }, "DEPARTMENT": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Department" }, "SENIORITY_LEVEL": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Seniority level" }, "HEADLINE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Headline" }, "SUMMARY": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Summary" }, "SKILLS": { "anyOf": [ { "items": { "type": "string", "maxLength": 65536 }, "type": "array", "maxItems": 1000 }, { "type": "null" } ], "title": "Skills" }, "WORK_EXPERIENCE": { "anyOf": [ { "items": { "$ref": "#/components/schemas/WorkExperience" }, "type": "array", "maxItems": 1000 }, { "type": "null" } ], "title": "Work experience" }, "EDUCATION_HISTORY": { "anyOf": [ { "items": { "$ref": "#/components/schemas/EducationHistory" }, "type": "array", "maxItems": 1000 }, { "type": "null" } ], "title": "Education history" }, "POSTS": { "anyOf": [ { "items": { "additionalProperties": { "$ref": "#/components/schemas/JsonValue" }, "type": "object" }, "type": "array", "maxItems": 1000 }, { "type": "null" } ], "title": "Posts" }, "CURRENT_BUSINESS_EMAIL": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Current business email" }, "CURRENT_BUSINESS_EMAIL_VALIDATION_STATUS": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Business email validation status" }, "CURRENT_BUSINESS_EMAIL_VALIDATION_DATE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Business email validation date" }, "EMAILS": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "items": { "type": "string", "maxLength": 65536 }, "type": "array", "maxItems": 1000 }, { "type": "null" } ], "title": "Emails" }, "PHONES": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "items": { "type": "string", "maxLength": 65536 }, "type": "array", "maxItems": 1000 }, { "type": "null" } ], "title": "Phones" }, "MOBILE_PHONE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Mobile phone" }, "MOBILE_PHONE_VALIDATION_STATUS": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Mobile phone validation status" }, "LINKEDIN_URL": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "LinkedIn URL" }, "PERSONAL_ADDRESS": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Address" }, "PERSONAL_ZIP": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Postal code" }, "LAST_UPDATED": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Last updated" }, "COMPANY_DESCRIPTION": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company description" }, "COMPANY_INDUSTRY": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company industry" }, "COMPANY_REVENUE_RANGE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Revenue range" }, "COMPANY_NUM_EMPLOYEE_RANGE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company size" }, "COMPANY_OWNERSHIP": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Ownership" }, "COMPANY_LATEST_FUNDING_STAGE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Latest funding stage" }, "COMPANY_LATEST_FUNDING_ROUND_DATE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Latest funding date" }, "COMPANY_TOTAL_FUNDING": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Total funding" }, "COMPANY_STOCK_EXCHANGE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Stock exchange" }, "COMPANY_TICKER_SYMBOL": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Ticker symbol" }, "COMPANY_STOCK_SYMBOL": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Stock symbol" }, "COMPANY_MARKET_CAPITALIZATION": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Market capitalization" }, "COMPANY_TOTAL_REVENUE": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Total revenue" }, "COMPANY_NUMBER_OF_FOLLOWERS": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Followers" }, "COMPANY_CITY": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company city" }, "COMPANY_STATE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company state" }, "COMPANY_COUNTRY": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company country" }, "COMPANY_COUNTRY_NUMERIC": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Country numeric code" }, "COMPANY_ADDRESS": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company address" }, "COMPANY_ZIP_CODE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company postal code" }, "COMPANY_FOUNDED_YEAR": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Founded year" }, "COMPANY_LINKEDIN_URL": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company LinkedIn URL" }, "COMPANY_FACEBOOK_URL": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company Facebook URL" }, "COMPANY_TWITTER_URL": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company Twitter URL" }, "COMPANY_ANGELLIST_URL": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company AngelList URL" }, "COMPANY_TECHNOLOGIES": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "items": { "type": "string", "maxLength": 65536 }, "type": "array", "maxItems": 1000 }, { "type": "null" } ], "title": "Technologies" }, "COMPANY_RETAIL_LOCATION_COUNT": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Retail locations" }, "company_record_id": { "anyOf": [ { "type": "string", "pattern": "^[a-f0-9]{32}$" }, { "type": "null" } ], "title": "Company Record Id", "description": "Optional workspace company relationship; never the dataset COMPANY_ID." } }, "additionalProperties": false, "type": "object", "title": "PersonFields" }, "PersonPreview": { "properties": { "UUID": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Person UUID" }, "FIRST_NAME": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "First name" }, "LAST_NAME": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Last name" }, "PHOTO_URL": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Photo URL" }, "COMPANY_NAME": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company name" }, "JOB_TITLE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Job title" }, "COMPANY_LOGO_URL": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company logo URL" }, "PERSONAL_CITY": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "City" }, "PERSONAL_STATE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "State" }, "PERSONAL_COUNTRY": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Country" }, "COMPANY_DOMAIN": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company domain" } }, "additionalProperties": false, "type": "object", "title": "PersonPreview" }, "PersonView": { "properties": { "id": { "type": "string", "title": "Id" }, "revision": { "type": "integer", "title": "Revision" }, "state": { "type": "string", "enum": [ "active", "archived" ], "title": "State" }, "source": { "type": "string", "enum": [ "manual", "catalogue" ], "title": "Source", "default": "manual" }, "source_state": { "anyOf": [ { "$ref": "#/components/schemas/SourceState" }, { "type": "null" } ] }, "data_access": { "type": "string", "enum": [ "user_provided", "preview_only", "licensed" ], "title": "Data Access", "default": "user_provided" }, "owned_snapshot": { "anyOf": [ { "$ref": "#/components/schemas/OwnedData" }, { "type": "null" } ] }, "created_at": { "type": "string", "title": "Created At" }, "updated_at": { "type": "string", "title": "Updated At" }, "fields": { "$ref": "#/components/schemas/PersonData" }, "company_record_id": { "anyOf": [ { "type": "string", "pattern": "^[a-f0-9]{32}$" }, { "type": "null" } ], "title": "Company Record Id" }, "preview": { "$ref": "#/components/schemas/PersonPreview", "description": "Approved display fields from the selected owned snapshot, otherwise the current live catalogue record or supplied fields, with explicit overrides. Source unavailability never substitutes a stale preview. Not an export or refresh grant." }, "overridden_fields": { "items": { "type": "string", "enum": [ "UUID", "FIRST_NAME", "LAST_NAME", "PHOTO_URL", "COMPANY_NAME", "JOB_TITLE", "COMPANY_LOGO_URL", "PERSONAL_CITY", "PERSONAL_STATE", "PERSONAL_COUNTRY", "COMPANY_DOMAIN", "MIDDLE_NAME", "DEPARTMENT", "SENIORITY_LEVEL", "HEADLINE", "SUMMARY", "SKILLS", "WORK_EXPERIENCE", "EDUCATION_HISTORY", "POSTS", "CURRENT_BUSINESS_EMAIL", "CURRENT_BUSINESS_EMAIL_VALIDATION_STATUS", "CURRENT_BUSINESS_EMAIL_VALIDATION_DATE", "EMAILS", "PHONES", "MOBILE_PHONE", "MOBILE_PHONE_VALIDATION_STATUS", "LINKEDIN_URL", "PERSONAL_ADDRESS", "PERSONAL_ZIP", "LAST_UPDATED", "COMPANY_DESCRIPTION", "COMPANY_INDUSTRY", "COMPANY_REVENUE_RANGE", "COMPANY_NUM_EMPLOYEE_RANGE", "COMPANY_OWNERSHIP", "COMPANY_LATEST_FUNDING_STAGE", "COMPANY_LATEST_FUNDING_ROUND_DATE", "COMPANY_TOTAL_FUNDING", "COMPANY_STOCK_EXCHANGE", "COMPANY_TICKER_SYMBOL", "COMPANY_STOCK_SYMBOL", "COMPANY_MARKET_CAPITALIZATION", "COMPANY_TOTAL_REVENUE", "COMPANY_NUMBER_OF_FOLLOWERS", "COMPANY_CITY", "COMPANY_STATE", "COMPANY_COUNTRY", "COMPANY_COUNTRY_NUMERIC", "COMPANY_ADDRESS", "COMPANY_ZIP_CODE", "COMPANY_FOUNDED_YEAR", "COMPANY_LINKEDIN_URL", "COMPANY_FACEBOOK_URL", "COMPANY_TWITTER_URL", "COMPANY_ANGELLIST_URL", "COMPANY_TECHNOLOGIES", "COMPANY_RETAIL_LOCATION_COUNT" ] }, "type": "array", "maxItems": 64, "title": "Overridden Fields", "description": "Explicit manual overrides present in fields, including nulls; empty for manual records." } }, "type": "object", "required": [ "id", "revision", "state", "created_at", "updated_at", "fields", "preview", "overridden_fields" ], "title": "PersonView" }, "Picklist": { "properties": { "type": { "type": "string", "const": "picklist", "title": "Type" }, "values": { "items": { "type": "string", "maxLength": 256, "minLength": 1, "pattern": "^[^\\x00-\\x1f\\x7f]+$" }, "type": "array", "maxItems": 100, "minItems": 1, "title": "Values" }, "operator": { "type": "string", "enum": [ "OR", "AND", "EXCLUDE" ], "title": "Operator", "default": "OR" } }, "additionalProperties": false, "type": "object", "required": [ "type", "values" ], "title": "Picklist" }, "PlacementCounts": { "properties": { "primary": { "type": "integer", "title": "Primary" }, "spam": { "type": "integer", "title": "Spam" }, "promotions": { "type": "integer", "title": "Promotions" }, "other": { "type": "integer", "title": "Other" }, "not_found": { "type": "integer", "title": "Not Found" }, "unknown": { "type": "integer", "title": "Unknown" }, "expected": { "type": "integer", "title": "Expected" } }, "additionalProperties": false, "type": "object", "required": [ "primary", "spam", "promotions", "other", "not_found", "unknown", "expected" ], "title": "PlacementCounts" }, "PolicyStatus": { "properties": { "current": { "anyOf": [ { "$ref": "#/components/schemas/Observation" }, { "type": "null" } ] }, "state": { "type": "string", "enum": [ "ready", "replanning", "unavailable" ], "title": "State" }, "error": { "type": "string", "title": "Error" }, "inbound": { "anyOf": [ { "$ref": "#/components/schemas/InboundAvailability" }, { "type": "null" } ] } }, "type": "object", "required": [ "current", "state", "error", "inbound" ], "title": "PolicyStatus" }, "PreparingReview": { "properties": { "kind": { "type": "string", "const": "review_preparation", "title": "Kind", "default": "review_preparation" }, "id": { "type": "string", "title": "Id" }, "state": { "type": "string", "enum": [ "preparing", "failed", "cancelled", "expired" ], "title": "State" }, "entity_type": { "type": "string", "enum": [ "person", "company" ], "title": "Entity Type" }, "created_at": { "type": "string", "title": "Created At" }, "updated_at": { "type": "string", "title": "Updated At" }, "expires_at": { "type": "string", "title": "Expires At" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" }, "can_confirm": { "type": "boolean", "const": false, "title": "Can Confirm", "default": false } }, "additionalProperties": false, "type": "object", "required": [ "id", "state", "entity_type", "created_at", "updated_at", "expires_at", "reason" ], "title": "PreparingReview" }, "Presence": { "properties": { "type": { "type": "string", "const": "exists", "title": "Type" }, "value": { "type": "boolean", "title": "Value", "default": true } }, "additionalProperties": false, "type": "object", "required": [ "type" ], "title": "Presence" }, "PreviewCopy": { "properties": { "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subject" }, "body": { "type": "string", "title": "Body" } }, "type": "object", "required": [ "subject", "body" ], "title": "PreviewCopy" }, "PreviewRefresh": { "properties": { "expected_revision": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Expected Revision" }, "expected_check_revision": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Expected Check Revision" }, "version_id": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Version Id" }, "reset_overrides": { "items": { "type": "string", "enum": [ "FIRST_NAME", "LAST_NAME", "MIDDLE_NAME", "JOB_TITLE", "DEPARTMENT", "SENIORITY_LEVEL", "HEADLINE", "SUMMARY", "SKILLS", "WORK_EXPERIENCE", "EDUCATION_HISTORY", "POSTS", "CURRENT_BUSINESS_EMAIL", "CURRENT_BUSINESS_EMAIL_VALIDATION_STATUS", "CURRENT_BUSINESS_EMAIL_VALIDATION_DATE", "EMAILS", "PHONES", "MOBILE_PHONE", "MOBILE_PHONE_VALIDATION_STATUS", "LINKEDIN_URL", "PERSONAL_CITY", "PERSONAL_STATE", "PERSONAL_COUNTRY", "PERSONAL_ADDRESS", "PERSONAL_ZIP", "LAST_UPDATED", "COMPANY_NAME", "COMPANY_DOMAIN", "COMPANY_DESCRIPTION", "COMPANY_INDUSTRY", "COMPANY_REVENUE_RANGE", "COMPANY_NUM_EMPLOYEE_RANGE", "COMPANY_OWNERSHIP", "COMPANY_LATEST_FUNDING_STAGE", "COMPANY_LATEST_FUNDING_ROUND_DATE", "COMPANY_TOTAL_FUNDING", "COMPANY_STOCK_EXCHANGE", "COMPANY_TICKER_SYMBOL", "COMPANY_STOCK_SYMBOL", "COMPANY_MARKET_CAPITALIZATION", "COMPANY_TOTAL_REVENUE", "COMPANY_NUMBER_OF_FOLLOWERS", "COMPANY_CITY", "COMPANY_STATE", "COMPANY_COUNTRY", "COMPANY_COUNTRY_NUMERIC", "COMPANY_ADDRESS", "COMPANY_ZIP_CODE", "COMPANY_FOUNDED_YEAR", "COMPANY_LINKEDIN_URL", "COMPANY_FACEBOOK_URL", "COMPANY_TWITTER_URL", "COMPANY_ANGELLIST_URL", "COMPANY_TECHNOLOGIES", "COMPANY_RETAIL_LOCATION_COUNT", "COMPANY_ID", "COMPANY_LOGO_URL", "UUID", "PHOTO_URL" ] }, "type": "array", "maxItems": 64, "title": "Reset Overrides" } }, "additionalProperties": false, "type": "object", "required": [ "expected_revision", "expected_check_revision", "version_id" ], "title": "PreviewRefresh" }, "Processing": { "properties": { "enabled": { "type": "boolean", "title": "Enabled" }, "error": { "type": "string", "title": "Error" }, "limit_usd_micros": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Limit Usd Micros" }, "spent_usd_micros": { "type": "integer", "title": "Spent Usd Micros" }, "held_usd_micros": { "type": "integer", "title": "Held Usd Micros" } }, "type": "object", "required": [ "enabled", "error", "limit_usd_micros", "spent_usd_micros", "held_usd_micros" ], "title": "Processing" }, "ProjectedDay": { "properties": { "date": { "type": "string", "title": "Date" }, "configured_target": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Configured Target", "default": 0 }, "capacity_ceiling": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Capacity Ceiling" }, "accepted": { "$ref": "#/components/schemas/sequencer__application__send_projection__Counts" }, "estimated": { "$ref": "#/components/schemas/sequencer__application__send_projection__Counts" }, "conditional": { "$ref": "#/components/schemas/sequencer__application__send_projection__Counts" }, "carry_forward": { "type": "integer", "title": "Carry Forward", "default": 0 } }, "additionalProperties": false, "type": "object", "required": [ "date" ], "title": "ProjectedDay" }, "ProjectionConflict": { "properties": { "detail": { "$ref": "#/components/schemas/ProjectionConflictDetail" } }, "additionalProperties": false, "type": "object", "required": [ "detail" ], "title": "ProjectionConflict" }, "ProjectionConflictDetail": { "properties": { "code": { "type": "string", "title": "Code" } }, "additionalProperties": false, "type": "object", "required": [ "code" ], "title": "ProjectionConflictDetail" }, "ProvisioningCompensation": { "properties": { "state": { "type": "string", "enum": [ "prepared", "submitted", "unknown", "issued", "not_due" ], "title": "State" }, "amount_cents": { "type": "integer", "title": "Amount Cents" }, "credited_cents": { "type": "integer", "title": "Credited Cents" }, "credit_note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Credit Note" }, "next_check": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Next Check" }, "cause": { "type": "string", "title": "Cause" }, "scope": { "type": "string", "const": "infrastructure_only", "title": "Scope" } }, "additionalProperties": false, "type": "object", "required": [ "state", "amount_cents", "credited_cents", "credit_note", "next_check", "cause", "scope" ], "title": "ProvisioningCompensation" }, "ProvisioningOrder": { "properties": { "id": { "type": "string", "title": "Id" }, "state": { "type": "string", "enum": [ "prepared", "submitted", "unknown", "provisioning", "purchased", "failed", "quarantined", "stopped" ], "title": "State" }, "daily_sends": { "type": "integer", "title": "Daily Sends" }, "funded_receipt_recorded": { "type": "boolean", "title": "Funded Receipt Recorded" }, "observed_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Observed At" }, "next_check": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Next Check" }, "cause": { "type": "string", "title": "Cause" } }, "additionalProperties": false, "type": "object", "required": [ "id", "state", "daily_sends", "funded_receipt_recorded", "observed_at", "next_check", "cause" ], "title": "ProvisioningOrder" }, "ProvisioningReview": { "properties": { "policy": { "type": "string", "title": "Policy" }, "ready_daily_sends": { "type": "integer", "title": "Ready Daily Sends" }, "provisioning_daily_sends": { "type": "integer", "title": "Provisioning Daily Sends" }, "deadline_at": { "type": "integer", "title": "Deadline At" }, "estimated_ready_at": { "type": "null", "title": "Estimated Ready At" }, "supplier_funding_source": { "type": "string", "enum": [ "owner_test", "customer_live" ], "title": "Supplier Funding Source" }, "owner_test_costs": { "anyOf": [ { "$ref": "#/components/schemas/OwnerTestCosts" }, { "type": "null" } ] }, "compensation_policy": { "type": "string", "title": "Compensation Policy" }, "credit_scope": { "type": "string", "const": "infrastructure_only", "title": "Credit Scope" } }, "additionalProperties": false, "type": "object", "required": [ "policy", "ready_daily_sends", "provisioning_daily_sends", "deadline_at", "estimated_ready_at", "supplier_funding_source", "owner_test_costs", "compensation_policy", "credit_scope" ], "title": "ProvisioningReview" }, "ProvisioningStatus": { "properties": { "requested_daily_sends": { "type": "integer", "title": "Requested Daily Sends" }, "supplier_funding_source": { "type": "string", "enum": [ "owner_test", "customer_live" ], "title": "Supplier Funding Source" }, "applied_daily_sends": { "type": "integer", "title": "Applied Daily Sends" }, "applied_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Applied At" }, "retained_reviewed_daily_sends": { "type": "integer", "title": "Retained Reviewed Daily Sends" }, "supplier_funded_daily_sends": { "type": "integer", "title": "Supplier Funded Daily Sends" }, "failed_daily_sends": { "type": "integer", "title": "Failed Daily Sends" }, "unknown_daily_sends": { "type": "integer", "title": "Unknown Daily Sends" }, "provisioning_daily_sends": { "type": "integer", "title": "Provisioning Daily Sends" }, "deadline_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Deadline At" }, "orders": { "items": { "$ref": "#/components/schemas/ProvisioningOrder" }, "type": "array", "title": "Orders" }, "payment_recorded": { "type": "boolean", "title": "Payment Recorded" }, "review_required": { "type": "string", "title": "Review Required" }, "compensation": { "anyOf": [ { "$ref": "#/components/schemas/ProvisioningCompensation" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "required": [ "requested_daily_sends", "supplier_funding_source", "applied_daily_sends", "applied_at", "retained_reviewed_daily_sends", "supplier_funded_daily_sends", "failed_daily_sends", "unknown_daily_sends", "provisioning_daily_sends", "deadline_at", "orders", "payment_recorded", "review_required", "compensation" ], "title": "ProvisioningStatus" }, "PurchasedReviewRow": { "properties": { "ordinal": { "type": "integer", "title": "Ordinal" }, "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Key" }, "record_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Record Id" }, "version_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version Id" }, "grant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Grant Id" }, "outcome": { "type": "string", "enum": [ "owned", "provided", "preview", "excluded", "newly_granted", "already_owned" ], "title": "Outcome" }, "fields": { "anyOf": [ { "additionalProperties": { "$ref": "#/components/schemas/JsonValue" }, "type": "object" }, { "type": "null" } ], "title": "Fields", "description": "Original delivered projection, not a request for new fields. Historical keys are preserved without conversion." }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" }, "amount_minor": { "type": "integer", "minimum": 0.0, "title": "Amount Minor", "default": 0 } }, "additionalProperties": false, "type": "object", "required": [ "ordinal", "key", "record_id", "version_id", "grant_id", "outcome", "fields", "reason" ], "title": "PurchasedReviewRow" }, "Quality": { "properties": { "campaign": { "type": "string", "title": "Campaign" }, "policy": { "type": "string", "title": "Policy" }, "configured": { "type": "boolean", "title": "Configured" }, "counts": { "$ref": "#/components/schemas/sequencer__application__name_cleaning_api__Counts" }, "processing": { "$ref": "#/components/schemas/Processing" }, "rows": { "items": { "$ref": "#/components/schemas/Recipient" }, "type": "array", "title": "Rows" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "observed_at": { "type": "number", "title": "Observed At" } }, "type": "object", "required": [ "campaign", "policy", "configured", "counts", "processing", "rows", "next_cursor", "observed_at" ], "title": "Quality" }, "QueueBacklog": { "properties": { "first_touches": { "type": "integer", "title": "First Touches" }, "followups": { "type": "integer", "title": "Followups" }, "eligible_first_touches": { "type": "integer", "title": "Eligible First Touches" }, "eligible_followups": { "type": "integer", "title": "Eligible Followups" }, "oldest_eligible_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Oldest Eligible At" } }, "type": "object", "required": [ "first_touches", "followups", "eligible_first_touches", "eligible_followups", "oldest_eligible_at" ], "title": "QueueBacklog" }, "Range": { "properties": { "type": { "type": "string", "const": "range", "title": "Type" }, "gte": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Gte" }, "gt": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Gt" }, "lte": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Lte" }, "lt": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Lt" } }, "additionalProperties": false, "type": "object", "required": [ "type" ], "title": "Range" }, "ReactivationSummary": { "properties": { "id": { "type": "string", "title": "Id" }, "state": { "type": "string", "enum": [ "quoted", "pending", "active", "cancelled" ], "title": "State" }, "blocker": { "type": "string", "title": "Blocker" } }, "additionalProperties": false, "type": "object", "required": [ "id", "state", "blocker" ], "title": "ReactivationSummary" }, "ReadIn": { "properties": { "through_seq": { "type": "integer", "minimum": 0.0, "title": "Through Seq" }, "unread": { "type": "boolean", "title": "Unread", "default": false } }, "additionalProperties": false, "type": "object", "required": [ "through_seq" ], "title": "ReadIn" }, "ReadinessPage": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ReadinessRecipient" }, "type": "array", "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "observed_at": { "type": "number", "title": "Observed At" }, "revision": { "items": { "type": "integer" }, "type": "array", "title": "Revision" }, "snapshot": { "type": "boolean", "const": false, "title": "Snapshot" }, "coverage": { "type": "string", "title": "Coverage" } }, "type": "object", "required": [ "items", "next_cursor", "observed_at", "revision", "snapshot", "coverage" ], "title": "ReadinessPage" }, "ReadinessRecipient": { "properties": { "recipient": { "type": "string", "title": "Recipient" }, "enrollment_state": { "type": "string", "title": "Enrollment State" }, "steps": { "items": { "$ref": "#/components/schemas/ReadinessStep" }, "type": "array", "title": "Steps" }, "verification": { "$ref": "#/components/schemas/VerificationView" } }, "type": "object", "required": [ "recipient", "enrollment_state", "steps", "verification" ], "title": "ReadinessRecipient" }, "ReadinessStep": { "properties": { "step": { "type": "integer", "title": "Step" }, "sequence_position": { "type": "integer", "title": "Sequence Position" }, "state": { "type": "string", "title": "State" }, "logical_state": { "type": "string", "enum": [ "ready", "contingent", "blocked", "skipped", "historical" ], "title": "Logical State" }, "reason": { "type": "string", "title": "Reason" }, "job": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Job" }, "due_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Due At" }, "next_check_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Next Check At" } }, "type": "object", "required": [ "step", "sequence_position", "state", "logical_state", "reason", "job", "due_at", "next_check_at" ], "title": "ReadinessStep" }, "Receipt": { "properties": { "id": { "type": "string", "title": "Id" }, "workspace": { "type": "string", "title": "Workspace" }, "campaign": { "type": "string", "title": "Campaign" }, "action": { "type": "string", "enum": [ "create", "edit", "append", "exclude", "discard" ], "title": "Action" }, "request_digest": { "type": "string", "title": "Request Digest" }, "actor": { "type": "string", "title": "Actor" }, "expected_revision": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Expected Revision" }, "before_revision": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Before Revision" }, "after_revision": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "After Revision" }, "outcome": { "type": "string", "enum": [ "recorded", "no_effect" ], "title": "Outcome" }, "state_after": { "type": "string", "enum": [ "draft", "discarded", "active", "paused", "complete" ], "title": "State After" }, "counts": { "$ref": "#/components/schemas/sequencer__application__draft_operations__Counts" }, "recorded_at": { "type": "number", "title": "Recorded At" } }, "additionalProperties": false, "type": "object", "required": [ "id", "workspace", "campaign", "action", "request_digest", "actor", "expected_revision", "before_revision", "after_revision", "outcome", "state_after", "counts", "recorded_at" ], "title": "Receipt" }, "Recipient": { "properties": { "id": { "type": "string", "title": "Id" }, "email": { "type": "string", "title": "Email" }, "state": { "type": "string", "enum": [ "unchecked", "ready", "pending", "held", "unavailable" ], "title": "State" }, "reason": { "type": "string", "title": "Reason" }, "field": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Field" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First Name" } }, "type": "object", "required": [ "id", "email", "state", "reason", "field", "first_name" ], "title": "Recipient" }, "RecipientEligibility": { "properties": { "status": { "type": "string", "enum": [ "qualified", "preparing", "waiting", "ineligible", "contacted", "stopped", "needs_review" ], "title": "Status" }, "reasons": { "items": { "type": "string" }, "type": "array", "title": "Reasons" }, "qualified": { "type": "boolean", "title": "Qualified" }, "contacted_in_campaign": { "type": "boolean", "title": "Contacted In Campaign" }, "observed_at": { "type": "number", "title": "Observed At" }, "last_contacted_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Last Contacted At" }, "eligible_after": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Eligible After" } }, "additionalProperties": false, "type": "object", "required": [ "status", "reasons", "qualified", "contacted_in_campaign", "observed_at", "last_contacted_at", "eligible_after" ], "title": "RecipientEligibility" }, "RecipientFields": { "properties": { "enrollment": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Enrollment" }, "fields": { "additionalProperties": { "type": "string" }, "type": "object", "maxProperties": 256, "title": "Fields" } }, "additionalProperties": false, "type": "object", "required": [ "enrollment", "fields" ], "title": "RecipientFields" }, "RecipientProgress": { "properties": { "sent": { "type": "integer", "minimum": 0.0, "title": "Sent", "description": "Automatic emails actually accepted, including steps since removed." }, "remaining": { "type": "integer", "maximum": 10.0, "minimum": 0.0, "title": "Remaining", "description": "Unsent, unskipped steps in the current definition; not guaranteed sends." }, "next_step": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Next Step", "description": "Stable logical step ID, not an ordinal." }, "next_position": { "anyOf": [ { "type": "integer", "maximum": 10.0, "minimum": 1.0 }, { "type": "null" } ], "title": "Next Position", "description": "One-based position in the current definition." }, "total": { "type": "integer", "maximum": 10.0, "minimum": 1.0, "title": "Total", "description": "Current definition length, not the historical sequence length." } }, "additionalProperties": false, "type": "object", "required": [ "sent", "remaining", "next_step", "next_position", "total" ], "title": "RecipientProgress" }, "RecipientVerification": { "properties": { "id": { "type": "string", "title": "Id" }, "email": { "type": "string", "title": "Email" }, "checked_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Checked At" }, "expires_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Expires At" }, "status": { "type": "string", "enum": [ "excluded", "stopped", "already_contacted", "not_enabled", "review_required", "pending", "expired", "required", "valid", "catch_all", "unknown", "invalid", "risky" ], "title": "Status" } }, "additionalProperties": false, "type": "object", "required": [ "id", "email", "checked_at", "expires_at", "status" ], "title": "RecipientVerification" }, "Reconciliation": { "properties": { "copy_phase": { "type": "string", "enum": [ "preparations", "complete" ], "title": "Copy Phase" }, "schedule_phase": { "type": "string", "enum": [ "jobs", "preparations", "complete" ], "title": "Schedule Phase" }, "examined": { "type": "integer", "minimum": 0.0, "title": "Examined", "description": "Rows examined, not a recipient count or total." }, "superseded": { "type": "boolean", "title": "Superseded", "description": "A newer accepted edit owns remaining propagation. This original remains recoverable." } }, "additionalProperties": false, "type": "object", "required": [ "copy_phase", "schedule_phase", "examined", "superseded" ], "title": "Reconciliation" }, "RecordLookup": { "properties": { "ids": { "items": { "type": "string", "maxLength": 256, "minLength": 1, "pattern": "^[^\\x00-\\x1f\\x7f]+$" }, "type": "array", "maxItems": 100, "minItems": 1, "title": "Ids" }, "id_type": { "type": "string", "enum": [ "source", "record" ], "title": "Id Type", "default": "record" } }, "additionalProperties": false, "type": "object", "required": [ "ids" ], "title": "RecordLookup" }, "RecordRefresh": { "properties": { "policy_id": { "type": "string", "maxLength": 100, "minLength": 1, "title": "Policy Id" }, "currency": { "type": "string", "const": "usd", "title": "Currency", "default": "usd" }, "max_amount_minor": { "type": "integer", "maximum": 10000000.0, "minimum": 0.0, "title": "Max Amount Minor" }, "action": { "type": "string", "const": "refresh", "title": "Action" }, "resource": { "type": "string", "enum": [ "contacts", "accounts" ], "title": "Resource" }, "record_id": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Record Id" }, "expected_revision": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Expected Revision" } }, "additionalProperties": false, "type": "object", "required": [ "policy_id", "max_amount_minor", "action", "resource", "record_id", "expected_revision" ], "title": "RecordRefresh" }, "RecordSelectionFilter": { "properties": { "q": { "type": "string", "maxLength": 200, "title": "Q", "description": "Same literal substring as saved-record browsing; no catalogue refresh.", "default": "" }, "data_access": { "anyOf": [ { "type": "string", "const": "licensed" }, { "type": "null" } ], "title": "Data Access" }, "view": { "type": "string", "enum": [ "saved", "contacts" ], "title": "View", "default": "saved" }, "source_freshness": { "anyOf": [ { "type": "string", "enum": [ "current", "update_available", "unavailable" ] }, { "type": "null" } ], "title": "Source Freshness" } }, "additionalProperties": false, "type": "object", "title": "RecordSelectionFilter" }, "RecordedCapacityRenewal": { "properties": { "enabled": { "type": "boolean", "title": "Enabled" }, "recurring_max_cents": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Recurring Max Cents" }, "revision": { "type": "integer", "title": "Revision" }, "keep_idle": { "type": "boolean", "title": "Keep Idle" }, "budget_cents": { "type": "integer", "title": "Budget Cents" }, "authorized_cents": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Authorized Cents" }, "blocker": { "type": "string", "title": "Blocker" }, "target_daily_sends": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Target Daily Sends" }, "target_max_cents": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Target Max Cents" } }, "additionalProperties": false, "type": "object", "required": [ "enabled", "revision", "keep_idle", "budget_cents", "authorized_cents", "blocker" ], "title": "RecordedCapacityRenewal", "description": "Frozen expansion policies may predate target and recurring-renewal fields." }, "RecordedJobCreate": { "properties": { "kind": { "type": "string", "enum": [ "import_records", "list_membership", "save_sources", "unlock", "refresh", "export", "export_review", "review_delivery", "source_check", "suppressions", "contact_history", "export_suppressions", "export_campaign", "campaign_admission" ], "title": "Kind" }, "import_id": { "anyOf": [ { "type": "string", "pattern": "^[a-f0-9]{32}$" }, { "type": "null" } ], "title": "Import Id" }, "expected_digest": { "anyOf": [ { "type": "string", "pattern": "^[a-f0-9]{64}$" }, { "type": "null" } ], "title": "Expected Digest" }, "scope": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/JobIdsScope" }, { "$ref": "#/components/schemas/JobListScope" }, { "$ref": "#/components/schemas/JobQueryScope-Output" }, { "$ref": "#/components/schemas/JobRecordsScope" } ], "discriminator": { "propertyName": "kind", "mapping": { "ids": "#/components/schemas/JobIdsScope", "list": "#/components/schemas/JobListScope", "query": "#/components/schemas/JobQueryScope-Output", "records": "#/components/schemas/JobRecordsScope" } } }, { "type": "null" } ], "title": "Scope" }, "max_records": { "type": "integer", "maximum": 5000000.0, "minimum": 1.0, "title": "Max Records" }, "prepare": { "type": "boolean", "title": "Prepare", "description": "Prepare a native scoped action without spending or producing an artifact. Explicit confirmation is required before execution.", "default": false }, "list_id": { "anyOf": [ { "type": "string", "pattern": "^[a-f0-9]{32}$" }, { "type": "null" } ], "title": "List Id" }, "expected_membership_revision": { "anyOf": [ { "type": "integer", "minimum": 1.0 }, { "type": "null" } ], "title": "Expected Membership Revision" }, "action": { "type": "string", "enum": [ "add", "remove" ], "title": "Action", "default": "add" }, "purchase": { "anyOf": [ { "$ref": "#/components/schemas/OrderTerms" }, { "type": "null" } ] }, "export": { "anyOf": [ { "$ref": "#/components/schemas/JobExport" }, { "type": "null" } ] }, "review": { "anyOf": [ { "$ref": "#/components/schemas/RecordedReviewSpec" }, { "type": "null" } ] }, "delivery": { "anyOf": [ { "$ref": "#/components/schemas/RecordedReviewConfirm" }, { "type": "null" } ] }, "campaign": { "anyOf": [ { "$ref": "#/components/schemas/CampaignAdmissionTarget" }, { "type": "null" } ] }, "exclusions": { "anyOf": [ { "$ref": "#/components/schemas/SuppressionExport" }, { "type": "null" } ] }, "recipients": { "anyOf": [ { "$ref": "#/components/schemas/CampaignExport" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "required": [ "kind", "max_records" ], "title": "RecordedJobCreate" }, "RecordedReviewConfirm": { "properties": { "expected_revision": { "type": "integer", "minimum": 1.0, "title": "Expected Revision" }, "expected_digest": { "type": "string", "pattern": "^[a-f0-9]{64}$", "title": "Expected Digest" }, "delivery": { "type": "string", "enum": [ "json", "csv", "json_job", "csv_job" ], "title": "Delivery", "default": "json" }, "currency": { "type": "string", "const": "usd", "title": "Currency", "default": "usd" }, "max_amount_minor": { "type": "integer", "maximum": 10000000.0, "minimum": 0.0, "title": "Max Amount Minor", "default": 0 }, "review_id": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Review Id" } }, "additionalProperties": false, "type": "object", "required": [ "expected_revision", "expected_digest", "review_id" ], "title": "RecordedReviewConfirm" }, "RecordedReviewCreate": { "properties": { "version_mode": { "type": "string", "enum": [ "owned", "owned_or_new", "latest", "updates_only" ], "title": "Version Mode", "default": "owned" }, "projection": { "type": "string", "enum": [ "effective", "licensed" ], "title": "Projection", "default": "effective" }, "fields": { "items": { "type": "string" }, "type": "array", "title": "Fields", "description": "Original requested columns, preserved without conversion." }, "file_format": { "type": "string", "enum": [ "csv", "json", "jsonl", "xlsx" ], "title": "File Format", "default": "csv" }, "policy_id": { "anyOf": [ { "type": "string", "maxLength": 100, "minLength": 1 }, { "type": "null" } ], "title": "Policy Id" }, "max_bytes": { "type": "integer", "maximum": 8589934592.0, "minimum": 1.0, "title": "Max Bytes" }, "selection_id": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Selection Id" }, "expected_digest": { "type": "string", "pattern": "^[a-f0-9]{64}$", "title": "Expected Digest" }, "max_records": { "type": "integer", "maximum": 5000000.0, "minimum": 1.0, "title": "Max Records" } }, "additionalProperties": false, "type": "object", "required": [ "fields", "max_bytes", "selection_id", "expected_digest", "max_records" ], "title": "RecordedReviewCreate" }, "RecordedReviewSpec": { "properties": { "version_mode": { "type": "string", "enum": [ "owned", "owned_or_new", "latest", "updates_only" ], "title": "Version Mode", "default": "owned" }, "projection": { "type": "string", "enum": [ "effective", "licensed" ], "title": "Projection", "default": "effective" }, "fields": { "items": { "type": "string" }, "type": "array", "title": "Fields", "description": "Original requested columns, not authority to request retired fields again." }, "file_format": { "type": "string", "enum": [ "csv", "json", "jsonl", "xlsx" ], "title": "File Format", "default": "csv" }, "policy_id": { "anyOf": [ { "type": "string", "maxLength": 100, "minLength": 1 }, { "type": "null" } ], "title": "Policy Id" }, "max_bytes": { "type": "integer", "maximum": 8589934592.0, "minimum": 1.0, "title": "Max Bytes" }, "selection_id": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Selection Id" } }, "additionalProperties": false, "type": "object", "required": [ "fields", "max_bytes", "selection_id" ], "title": "RecordedReviewSpec" }, "RecordedSend": { "properties": { "recipient": { "type": "string", "title": "Recipient" }, "step": { "type": "integer", "title": "Step" }, "sequence_position": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sequence Position" }, "sequence_total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sequence Total" }, "state": { "type": "string", "title": "State" }, "recorded_at": { "type": "number", "title": "Recorded At" }, "content": { "anyOf": [ { "$ref": "#/components/schemas/MessageCopy" }, { "type": "null" } ] }, "copy_source": { "type": "string", "title": "Copy Source" }, "verification_verdict": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Verification Verdict" }, "verification_policy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Verification Policy" }, "delivery_state": { "type": "string", "enum": [ "failed", "delayed", "unconfirmed", "not_applicable" ], "title": "Delivery State", "default": "not_applicable" } }, "type": "object", "required": [ "recipient", "step", "sequence_position", "sequence_total", "state", "recorded_at", "content", "copy_source", "verification_verdict", "verification_policy" ], "title": "RecordedSend" }, "Recovery": { "properties": { "maximum_cents": { "type": "integer", "minimum": 0.0, "title": "Maximum Cents" } }, "additionalProperties": false, "type": "object", "required": [ "maximum_cents" ], "title": "Recovery" }, "RefillConsent": { "properties": { "id": { "type": "string", "title": "Id" }, "campaign_id": { "type": "string", "title": "Campaign Id" }, "actor": { "type": "string", "title": "Actor" }, "parameters": { "$ref": "#/components/schemas/RefillConsentIn" }, "state": { "type": "string", "enum": [ "active", "held", "completed", "cancelled", "expired" ], "title": "State" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" }, "revision": { "type": "integer", "title": "Revision" }, "examined": { "type": "integer", "title": "Examined" }, "added": { "type": "integer", "title": "Added" }, "held": { "type": "integer", "title": "Held" }, "already_admitted": { "type": "integer", "title": "Already Admitted" }, "send_budget_added_cents": { "type": "integer", "title": "Send Budget Added Cents" }, "last_admission_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Admission Id" }, "created_at": { "type": "number", "title": "Created At" }, "updated_at": { "type": "number", "title": "Updated At" }, "sources": { "items": { "$ref": "#/components/schemas/SourceProgress" }, "type": "array", "title": "Sources" }, "preparation": { "anyOf": [ { "$ref": "#/components/schemas/IncludedPreparationCounts" }, { "type": "null" } ] } }, "type": "object", "required": [ "id", "campaign_id", "actor", "parameters", "state", "reason", "revision", "examined", "added", "held", "already_admitted", "send_budget_added_cents", "last_admission_id", "created_at", "updated_at", "sources" ], "title": "RefillConsent" }, "RefillConsentIn": { "properties": { "expected_campaign_revision": { "type": "integer", "minimum": 1.0, "title": "Expected Campaign Revision" }, "expected_sources_revision": { "type": "integer", "minimum": 1.0, "title": "Expected Sources Revision" }, "source_ids": { "items": { "type": "string", "pattern": "^[a-f0-9]{32}$" }, "type": "array", "maxItems": 50, "minItems": 1, "title": "Source Ids" }, "max_people": { "type": "integer", "maximum": 1000000.0, "minimum": 1.0, "title": "Max People" }, "max_memberships": { "type": "integer", "maximum": 50000000.0, "minimum": 1.0, "title": "Max Memberships" }, "expires_at": { "type": "number", "title": "Expires At" }, "max_send_budget_added_cents": { "type": "integer", "maximum": 1000000000.0, "minimum": 0.0, "title": "Max Send Budget Added Cents" }, "included_preparation": { "anyOf": [ { "$ref": "#/components/schemas/IncludedPreparationTerms" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "required": [ "expected_campaign_revision", "expected_sources_revision", "source_ids", "max_people", "max_memberships", "expires_at", "max_send_budget_added_cents" ], "title": "RefillConsentIn" }, "RefillError": { "properties": { "index": { "type": "integer", "title": "Index" }, "reason": { "type": "string", "enum": [ "invalid_email", "recipient_fields_conflict", "recipient_active_in_other_campaign", "recontact_cooldown", "contact_outcome_unknown", "recontact_date_unknown" ], "title": "Reason" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" } }, "additionalProperties": false, "type": "object", "required": [ "index", "reason" ], "title": "RefillError" }, "RefillHistory": { "properties": { "items": { "items": { "$ref": "#/components/schemas/RefillHistoryItem" }, "type": "array", "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Next Cursor" } }, "additionalProperties": false, "type": "object", "required": [ "items", "next_cursor" ], "title": "RefillHistory" }, "RefillHistoryItem": { "properties": { "id": { "type": "string", "title": "Id" }, "campaign": { "type": "string", "title": "Campaign" }, "added": { "type": "integer", "title": "Added" }, "duplicates": { "type": "integer", "title": "Duplicates" }, "suppressed": { "type": "integer", "title": "Suppressed" }, "conflicting": { "type": "integer", "title": "Conflicting" }, "audience_revision": { "type": "integer", "title": "Audience Revision" }, "send_budget_added_cents": { "type": "integer", "title": "Send Budget Added Cents" }, "send_budget_cents": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Send Budget Cents" }, "actor": { "type": "string", "title": "Actor" }, "created_at": { "type": "number", "title": "Created At" }, "invalid": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Invalid" }, "submitted": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Submitted" }, "error_count": { "type": "integer", "title": "Error Count" } }, "additionalProperties": false, "type": "object", "required": [ "id", "campaign", "added", "duplicates", "suppressed", "conflicting", "audience_revision", "send_budget_added_cents", "send_budget_cents", "actor", "created_at", "error_count" ], "title": "RefillHistoryItem" }, "RefillPage": { "properties": { "items": { "items": { "$ref": "#/components/schemas/RefillConsent" }, "type": "array", "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "type": "object", "required": [ "items", "next_cursor" ], "title": "RefillPage" }, "RefillResult": { "properties": { "id": { "type": "string", "title": "Id" }, "campaign": { "type": "string", "title": "Campaign" }, "added": { "type": "integer", "title": "Added" }, "duplicates": { "type": "integer", "title": "Duplicates" }, "suppressed": { "type": "integer", "title": "Suppressed" }, "conflicting": { "type": "integer", "title": "Conflicting" }, "audience_revision": { "type": "integer", "title": "Audience Revision" }, "send_budget_added_cents": { "type": "integer", "title": "Send Budget Added Cents" }, "send_budget_cents": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Send Budget Cents" }, "actor": { "type": "string", "title": "Actor" }, "created_at": { "type": "number", "title": "Created At" }, "invalid": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Invalid" }, "submitted": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Submitted" }, "errors": { "items": { "$ref": "#/components/schemas/RefillError" }, "type": "array", "title": "Errors" }, "next_error_cursor": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Next Error Cursor" } }, "additionalProperties": false, "type": "object", "required": [ "id", "campaign", "added", "duplicates", "suppressed", "conflicting", "audience_revision", "send_budget_added_cents", "send_budget_cents", "actor", "created_at", "errors", "next_error_cursor" ], "title": "RefillResult" }, "RefillScope": { "properties": { "expected_campaign_revision": { "type": "integer", "minimum": 1.0, "title": "Expected Campaign Revision" }, "expected_sources_revision": { "type": "integer", "minimum": 1.0, "title": "Expected Sources Revision" }, "source_ids": { "items": { "type": "string", "pattern": "^[a-f0-9]{32}$" }, "type": "array", "maxItems": 50, "minItems": 1, "title": "Source Ids" }, "max_people": { "type": "integer", "maximum": 1000000.0, "minimum": 1.0, "title": "Max People" }, "max_memberships": { "type": "integer", "maximum": 50000000.0, "minimum": 1.0, "title": "Max Memberships" }, "expires_at": { "type": "number", "title": "Expires At" } }, "additionalProperties": false, "type": "object", "required": [ "expected_campaign_revision", "expected_sources_revision", "source_ids", "max_people", "max_memberships", "expires_at" ], "title": "RefillScope" }, "ReplyBudgetIn": { "properties": { "id": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Id" }, "expected_revision": { "type": "integer", "minimum": 1.0, "title": "Expected Revision" }, "expected_send_price_cents": { "type": "integer", "maximum": 1000000.0, "minimum": 0.0, "title": "Expected Send Price Cents" }, "reply_budget_cents": { "type": "integer", "maximum": 1000000000.0, "minimum": 0.0, "title": "Reply Budget Cents" } }, "additionalProperties": false, "type": "object", "required": [ "id", "expected_revision", "expected_send_price_cents", "reply_budget_cents" ], "title": "ReplyBudgetIn", "description": "Owner-authorized reply-only ceiling; never spends or changes cold campaign allowance." }, "ReplyBudgetOriginal": { "properties": { "id": { "type": "string", "title": "Id" }, "kind": { "type": "string", "const": "reply_budget", "title": "Kind" }, "campaign": { "type": "string", "title": "Campaign" }, "campaign_revision": { "type": "integer", "title": "Campaign Revision" }, "state": { "type": "string", "enum": [ "draft", "active", "paused", "complete" ], "title": "State" }, "send_price_cents": { "type": "integer", "title": "Send Price Cents" }, "reply_budget_cents": { "type": "integer", "title": "Reply Budget Cents" }, "reply_committed_cents": { "type": "integer", "title": "Reply Committed Cents" }, "reply_allowance_committed_cents": { "type": "integer", "title": "Reply Allowance Committed Cents", "description": "Absent in older originals." }, "reviewed_at": { "type": "number", "title": "Reviewed At" }, "reviewed_by": { "type": "string", "title": "Reviewed By" } }, "additionalProperties": false, "type": "object", "required": [ "id", "kind", "campaign", "campaign_revision", "state", "send_price_cents", "reply_budget_cents", "reply_committed_cents", "reviewed_at", "reviewed_by" ], "title": "ReplyBudgetOriginal" }, "ReplyBudgetPage": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ReplyBudgetOriginal" }, "type": "array", "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "additionalProperties": false, "type": "object", "required": [ "items", "next_cursor" ], "title": "ReplyBudgetPage" }, "ReplyClassificationObservation": { "properties": { "state": { "type": "string", "enum": [ "pending", "leased", "suggested", "applied", "failed", "unknown" ], "title": "State" }, "model": { "type": "string", "title": "Model" }, "policy_version": { "type": "string", "title": "Policy Version" }, "suggestion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Suggestion" }, "choice_confidence": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Choice Confidence" }, "explicit_opt_out": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Explicit Opt Out" }, "input_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Input Tokens" }, "output_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Output Tokens" }, "cost_usd_micros": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Cost Usd Micros" }, "provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider" }, "resolved_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resolved Model" }, "error": { "type": "string", "title": "Error" }, "updated_at": { "type": "number", "title": "Updated At" }, "origin": { "type": "string", "enum": [ "live", "backfill" ], "title": "Origin" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" }, "probabilities": { "anyOf": [ { "additionalProperties": { "type": "number", "maximum": 1.0, "minimum": 0.0 }, "type": "object" }, { "type": "null" } ], "title": "Probabilities", "description": "Historical provider probability keys follow the recorded policy version; native evidence may be null." } }, "additionalProperties": false, "type": "object", "required": [ "state", "model", "policy_version", "suggestion", "choice_confidence", "explicit_opt_out", "input_tokens", "output_tokens", "cost_usd_micros", "provider", "resolved_model", "error", "updated_at", "origin", "reason", "probabilities" ], "title": "ReplyClassificationObservation" }, "ReplyIn": { "properties": { "source_event": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1 }, { "type": "null" } ], "title": "Source Event" }, "recipients": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 10, "minItems": 1 }, { "type": "null" } ], "title": "Recipients" }, "expected_send_price_cents": { "anyOf": [ { "type": "integer", "maximum": 1000000.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Expected Send Price Cents" }, "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", "description": "Literal plain-text body for a new human reply; not a campaign template. Reuse the exact original payload and ID to recover an existing reply." }, "html": { "type": "string", "maxLength": 100000, "title": "Html", "description": "Recovery-only for an already-recorded exact original. Must be empty for a new human reply; nonempty HTML is rejected with plain_text_reply_required before admission.", "default": "" }, "attachments": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "maxItems": 3, "title": "Attachments", "description": "Recovery-only for an already-recorded exact original. Must be empty for a new human reply; outgoing files are rejected with plain_text_reply_required. Incoming downloads are a separate read capability." } }, "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", "automated", "recipient_unavailable" ], "title": "Intent" }, "expected_revision": { "type": "integer", "minimum": 1.0, "title": "Expected Revision" } }, "additionalProperties": false, "type": "object", "required": [ "intent", "expected_revision" ], "title": "ReplyIntentIn" }, "ReplyResult": { "properties": { "job_id": { "type": "string", "title": "Job Id" }, "state": { "type": "string", "title": "State" } }, "additionalProperties": false, "type": "object", "required": [ "job_id", "state" ], "title": "ReplyResult" }, "ReplyReviewControls": { "properties": { "can_cancel": { "type": "boolean", "title": "Can Cancel" }, "authorize_price_cents": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Authorize Price Cents", "description": "Current per-recipient authorization price, not the earlier job price or a reservation. Null forbids authorization; zero is included. POST rechecks authority and price." }, "blocker": { "type": "string", "title": "Blocker" } }, "additionalProperties": false, "type": "object", "required": [ "can_cancel", "authorize_price_cents", "blocker" ], "title": "ReplyReviewControls" }, "ReplyReviewHistory": { "properties": { "job_id": { "type": "string", "title": "Job Id" }, "state": { "type": "string", "enum": [ "queued", "reserved", "dispatching", "accepted", "not_accepted", "unknown", "cancelled" ], "title": "State" }, "blocker": { "type": "string", "title": "Blocker" }, "authorization_revision": { "type": "integer", "title": "Authorization Revision" }, "reply_price_cents": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Reply Price Cents" }, "recipient_count": { "type": "integer", "minimum": 1.0, "title": "Recipient Count" }, "controls": { "$ref": "#/components/schemas/ReplyReviewControls" }, "items": { "items": { "$ref": "#/components/schemas/ReplyReviewReceipt" }, "type": "array", "maxItems": 100, "title": "Items", "description": "Known immutable receipt fields. Stored historical extensions remain verbatim; metadata does not filter them." }, "next_cursor": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Next Cursor" } }, "additionalProperties": false, "type": "object", "required": [ "job_id", "state", "blocker", "authorization_revision", "reply_price_cents", "recipient_count", "controls", "items", "next_cursor" ], "title": "ReplyReviewHistory" }, "ReplyReviewQueue": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ReplyReviewQueueItem" }, "type": "array", "maxItems": 200, "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "review_revision": { "type": "integer", "title": "Review Revision" } }, "additionalProperties": false, "type": "object", "required": [ "items", "next_cursor", "review_revision" ], "title": "ReplyReviewQueue" }, "ReplyReviewQueueItem": { "properties": { "event_id": { "type": "string", "title": "Event Id" }, "intent": { "type": "string", "title": "Intent" }, "revision": { "type": "integer", "title": "Revision" }, "received_at": { "type": "number", "title": "Received At" }, "conversation": { "type": "string", "title": "Conversation" }, "status": { "type": "string", "enum": [ "needs_reply", "waiting", "closed" ], "title": "Status" }, "conversation_revision": { "type": "integer", "title": "Conversation Revision" }, "last_inbound_seq": { "type": "integer", "title": "Last Inbound Seq" }, "attention_seq": { "type": "integer", "title": "Attention Seq" }, "archived": { "type": "integer", "enum": [ 0, 1 ], "title": "Archived" }, "unread": { "type": "integer", "enum": [ 0, 1 ], "title": "Unread" }, "email": { "type": "string", "title": "Email" }, "campaign": { "type": "string", "title": "Campaign" }, "campaign_name": { "type": "string", "title": "Campaign Name" }, "classifier_state": { "anyOf": [ { "type": "string", "enum": [ "pending", "leased", "suggested", "applied", "failed", "unknown" ] }, { "type": "null" } ], "title": "Classifier State" }, "suggestion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Suggestion" }, "choice_confidence": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Choice Confidence" }, "explicit_opt_out": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Explicit Opt Out" }, "classifier_error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Classifier Error" }, "classifier_updated_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Classifier Updated At" }, "classifier_origin": { "anyOf": [ { "type": "string", "enum": [ "live", "backfill" ] }, { "type": "null" } ], "title": "Classifier Origin" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" }, "probabilities": { "anyOf": [ { "additionalProperties": { "type": "number", "maximum": 1.0, "minimum": 0.0 }, "type": "object" }, { "type": "null" } ], "title": "Probabilities" } }, "additionalProperties": false, "type": "object", "required": [ "event_id", "intent", "revision", "received_at", "conversation", "status", "conversation_revision", "last_inbound_seq", "attention_seq", "archived", "unread", "email", "campaign", "campaign_name", "classifier_state", "suggestion", "choice_confidence", "explicit_opt_out", "classifier_error", "classifier_updated_at", "classifier_origin", "reason", "probabilities" ], "title": "ReplyReviewQueueItem" }, "ReplyReviewReceipt": { "properties": { "id": { "type": "string", "title": "Id" }, "job_id": { "type": "string", "title": "Job Id" }, "action": { "type": "string", "enum": [ "authorize", "cancel" ], "title": "Action" }, "state": { "type": "string", "enum": [ "queued", "cancelled" ], "title": "State" }, "authorization_revision": { "type": "integer", "title": "Authorization Revision" }, "reply_price_cents": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Reply Price Cents" }, "reviewed_by": { "type": "string", "title": "Reviewed By" }, "reviewed_at": { "type": "number", "title": "Reviewed At" }, "semantics": { "type": "string", "const": "immutable_review_receipt_not_current_delivery_status", "title": "Semantics" } }, "additionalProperties": true, "type": "object", "required": [ "id", "job_id", "action", "state", "authorization_revision", "reply_price_cents", "reviewed_by", "reviewed_at", "semantics" ], "title": "ReplyReviewReceipt", "x-opaque-reason": "Immutable stored reply-review receipts may retain historical extension fields; known original fields remain typed." }, "ReplyRule": { "properties": { "id": { "type": "string", "maxLength": 64, "minLength": 1, "pattern": "^[A-Za-z0-9_-]+$", "title": "Id" }, "label": { "type": "string", "maxLength": 80, "minLength": 1, "title": "Label" }, "condition": { "type": "string", "maxLength": 300, "title": "Condition" }, "guidance": { "type": "string", "maxLength": 1000, "minLength": 1, "title": "Guidance" }, "example": { "type": "string", "maxLength": 1000, "title": "Example" }, "link": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Link" }, "include_cc": { "type": "boolean", "title": "Include Cc" } }, "additionalProperties": false, "type": "object", "required": [ "id", "label", "condition", "guidance", "example", "link", "include_cc" ], "title": "ReplyRule" }, "ResolveInput": { "properties": { "key": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Key" }, "identifiers": { "additionalProperties": { "type": "string" }, "type": "object", "maxProperties": 3, "minProperties": 1, "title": "Identifiers" } }, "additionalProperties": false, "type": "object", "required": [ "key", "identifiers" ], "title": "ResolveInput" }, "ResolvePage": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ResolveResult" }, "type": "array", "title": "Items" }, "complete": { "type": "boolean", "title": "Complete" }, "hits": { "items": { "anyOf": [ { "$ref": "#/components/schemas/PersonPreview" }, { "$ref": "#/components/schemas/CompanyPreview" } ] }, "type": "array", "title": "Hits" }, "result_set_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Result Set Id" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "state": { "type": "string", "enum": [ "preparing", "ready" ], "title": "State", "default": "ready" }, "saved_records_available": { "type": "boolean", "title": "Saved Records Available", "default": false }, "saved_records": { "additionalProperties": { "$ref": "#/components/schemas/SavedRecordLink" }, "type": "object", "title": "Saved Records" }, "input_count": { "type": "integer", "title": "Input Count" }, "matched_count": { "type": "integer", "title": "Matched Count" }, "distinct_matches": { "type": "integer", "title": "Distinct Matches" }, "disclosure": { "type": "string", "enum": [ "single_input", "unlinked" ], "title": "Disclosure" }, "ambiguous_count": { "type": "integer", "title": "Ambiguous Count", "default": 0 }, "conflicting_count": { "type": "integer", "title": "Conflicting Count", "default": 0 }, "not_found_count": { "type": "integer", "title": "Not Found Count", "default": 0 }, "truncated_count": { "type": "integer", "title": "Truncated Count", "default": 0 } }, "type": "object", "required": [ "items", "complete", "input_count", "matched_count", "distinct_matches", "disclosure" ], "title": "ResolvePage" }, "ResolveRequest": { "properties": { "inputs": { "items": { "$ref": "#/components/schemas/ResolveInput" }, "type": "array", "maxItems": 100, "minItems": 1, "title": "Inputs" } }, "additionalProperties": false, "type": "object", "required": [ "inputs" ], "title": "ResolveRequest" }, "ResolveResult": { "properties": { "key": { "type": "string", "title": "Key" }, "status": { "type": "string", "enum": [ "matched", "ambiguous", "conflicting", "not_found" ], "title": "Status" }, "candidates": { "items": { "$ref": "#/components/schemas/SearchItem" }, "type": "array", "title": "Candidates" }, "truncated": { "type": "boolean", "title": "Truncated" }, "match_basis": { "type": "string", "const": "source_exact", "title": "Match Basis" } }, "type": "object", "required": [ "key", "status", "candidates", "truncated", "match_basis" ], "title": "ResolveResult" }, "Result": { "properties": { "operation": { "$ref": "#/components/schemas/Receipt" } }, "additionalProperties": false, "type": "object", "required": [ "operation" ], "title": "Result" }, "RetentionPreview": { "properties": { "desired_daily_sends": { "type": "integer", "title": "Desired Daily Sends" }, "allocated_daily_sends": { "type": "integer", "title": "Allocated Daily Sends" }, "term_cents": { "type": "integer", "title": "Term Cents" }, "period_seconds": { "type": "integer", "title": "Period Seconds" }, "effective_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Effective At" }, "immediate_charge_cents": { "type": "integer", "const": 0, "title": "Immediate Charge Cents" }, "refund_cents": { "type": "integer", "const": 0, "title": "Refund Cents" }, "allocations": { "items": { "$ref": "#/components/schemas/CapacityAllocation" }, "type": "array", "title": "Allocations" }, "semantics": { "type": "string", "const": "next_term_preview_not_purchase_authority", "title": "Semantics" }, "fingerprint": { "type": "string", "title": "Fingerprint" }, "rate_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rate Version" }, "already_paid_term": { "anyOf": [ { "$ref": "#/components/schemas/PaidCapacityTerm" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "required": [ "desired_daily_sends", "allocated_daily_sends", "term_cents", "period_seconds", "effective_at", "immediate_charge_cents", "refund_cents", "allocations", "semantics", "fingerprint" ], "title": "RetentionPreview" }, "RetryOriginal": { "properties": { "id": { "type": "string", "title": "Id" }, "created_at": { "type": "number", "title": "Created At" }, "outcome": { "type": "string", "const": "not_accepted", "title": "Outcome" }, "reason": { "type": "string", "title": "Reason" }, "origin": { "type": "string", "enum": [ "automatic", "reviewed" ], "title": "Origin" } }, "additionalProperties": false, "type": "object", "required": [ "id", "created_at", "outcome", "reason", "origin" ], "title": "RetryOriginal" }, "RetryPage": { "properties": { "items": { "items": { "$ref": "#/components/schemas/RetryOriginal" }, "type": "array", "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "additionalProperties": false, "type": "object", "required": [ "items", "next_cursor" ], "title": "RetryPage" }, "Review": { "properties": { "id": { "type": "string", "maxLength": 128, "minLength": 1, "pattern": "^[^_].*$", "title": "Id" }, "revision": { "type": "integer", "minimum": 0.0, "title": "Revision" }, "daily_sends": { "type": "integer", "maximum": 900.0, "minimum": 0.0, "title": "Daily Sends" }, "provisioning_policy": { "anyOf": [ { "type": "string", "const": "inboxkit-provisioning-v1" }, { "type": "null" } ], "title": "Provisioning Policy" } }, "additionalProperties": false, "type": "object", "required": [ "id", "revision", "daily_sends" ], "title": "Review" }, "ReviewArtifact": { "properties": { "format": { "type": "string", "enum": [ "csv_v1", "json_v1", "jsonl_v1", "xlsx_v1" ], "title": "Format", "default": "csv_v1" }, "columns": { "items": { "type": "string" }, "type": "array", "title": "Columns", "description": "Ordered column names recorded when this file was created." }, "rows": { "type": "integer", "maximum": 100.0, "minimum": 0.0, "title": "Rows" }, "bytes": { "type": "integer", "maximum": 1048576.0, "minimum": 1.0, "title": "Bytes" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$", "title": "Sha256" }, "expires_at": { "type": "string", "title": "Expires At" } }, "additionalProperties": false, "type": "object", "required": [ "columns", "rows", "bytes", "sha256", "expires_at" ], "title": "ReviewArtifact" }, "ReviewConfirm": { "properties": { "expected_revision": { "type": "integer", "minimum": 1.0, "title": "Expected Revision" }, "expected_digest": { "type": "string", "pattern": "^[a-f0-9]{64}$", "title": "Expected Digest" }, "delivery": { "type": "string", "enum": [ "json", "csv", "json_job", "csv_job" ], "title": "Delivery", "default": "json" }, "currency": { "type": "string", "const": "usd", "title": "Currency", "default": "usd" }, "max_amount_minor": { "type": "integer", "maximum": 10000000.0, "minimum": 0.0, "title": "Max Amount Minor", "default": 0 } }, "additionalProperties": false, "type": "object", "required": [ "expected_revision", "expected_digest" ], "title": "ReviewConfirm" }, "ReviewDelivery": { "properties": { "kind": { "type": "string", "const": "review_json", "title": "Kind", "default": "review_json" }, "id": { "type": "string", "title": "Id" }, "review_id": { "type": "string", "title": "Review Id" }, "state": { "type": "string", "const": "completed", "title": "State", "default": "completed" }, "entity_type": { "type": "string", "enum": [ "person", "company" ], "title": "Entity Type" }, "projection": { "type": "string", "enum": [ "effective", "licensed" ], "title": "Projection" }, "digest": { "type": "string", "title": "Digest" }, "currency": { "type": "string", "const": "usd", "title": "Currency", "default": "usd" }, "max_amount_minor": { "type": "integer", "const": 0, "title": "Max Amount Minor", "default": 0 }, "amount_minor": { "type": "integer", "const": 0, "title": "Amount Minor", "default": 0 }, "funding_required_minor": { "type": "integer", "const": 0, "title": "Funding Required Minor", "default": 0 }, "items": { "items": { "$ref": "#/components/schemas/DeliveredRow" }, "type": "array", "maxItems": 100, "title": "Items" }, "created_at": { "type": "string", "title": "Created At" }, "completed_at": { "type": "string", "title": "Completed At" }, "artifact": { "anyOf": [ { "$ref": "#/components/schemas/ReviewArtifact" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "required": [ "id", "review_id", "entity_type", "projection", "digest", "items", "created_at", "completed_at" ], "title": "ReviewDelivery" }, "ReviewDeliveryPage": { "properties": { "items": { "items": { "$ref": "#/components/schemas/PurchasedReviewRow" }, "type": "array", "title": "Items" }, "next_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Next After" }, "expires_at": { "type": "string", "title": "Expires At" } }, "type": "object", "required": [ "items", "next_after", "expires_at" ], "title": "ReviewDeliveryPage" }, "ReviewIn": { "properties": { "id": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Id" }, "expected_revision": { "type": "integer", "minimum": 0.0, "title": "Expected Revision" }, "action": { "type": "string", "enum": [ "authorize", "cancel" ], "title": "Action" }, "expected_send_price_cents": { "anyOf": [ { "type": "integer", "maximum": 1000000.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Expected Send Price Cents" } }, "additionalProperties": false, "type": "object", "required": [ "id", "expected_revision", "action" ], "title": "ReviewIn" }, "ReviewPurchase": { "properties": { "kind": { "type": "string", "const": "review_purchase", "title": "Kind", "default": "review_purchase" }, "id": { "type": "string", "title": "Id" }, "review_id": { "type": "string", "title": "Review Id" }, "state": { "type": "string", "enum": [ "awaiting_funds", "completed", "cancelled" ], "title": "State" }, "entity_type": { "type": "string", "enum": [ "person", "company" ], "title": "Entity Type" }, "projection": { "type": "string", "enum": [ "effective", "licensed" ], "title": "Projection" }, "digest": { "type": "string", "title": "Digest" }, "policy": { "$ref": "#/components/schemas/DataPolicy" }, "currency": { "type": "string", "const": "usd", "title": "Currency", "default": "usd" }, "max_amount_minor": { "type": "integer", "title": "Max Amount Minor" }, "amount_minor": { "type": "integer", "title": "Amount Minor" }, "funding_required_minor": { "type": "integer", "title": "Funding Required Minor" }, "initial_funding_required_minor": { "type": "integer", "title": "Initial Funding Required Minor" }, "automatic_funding": { "type": "boolean", "title": "Automatic Funding", "default": false }, "funding_error": { "type": "string", "title": "Funding Error", "default": "" }, "items": { "items": { "$ref": "#/components/schemas/PurchasedReviewRow" }, "type": "array", "maxItems": 100, "title": "Items" }, "created_at": { "type": "string", "title": "Created At" }, "completed_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Completed At" }, "artifact": { "anyOf": [ { "$ref": "#/components/schemas/ReviewArtifact" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "required": [ "id", "review_id", "state", "entity_type", "projection", "digest", "policy", "max_amount_minor", "amount_minor", "funding_required_minor", "initial_funding_required_minor", "items", "created_at", "completed_at" ], "title": "ReviewPurchase" }, "ReviewSummary": { "properties": { "owned_count": { "type": "integer", "title": "Owned Count", "default": 0 }, "provided_count": { "type": "integer", "title": "Provided Count", "default": 0 }, "preview_count": { "type": "integer", "title": "Preview Count", "default": 0 }, "new_count": { "type": "integer", "title": "New Count", "default": 0 }, "update_count": { "type": "integer", "title": "Update Count", "default": 0 }, "excluded_count": { "type": "integer", "title": "Excluded Count", "default": 0 }, "exclusions": { "additionalProperties": { "type": "integer" }, "type": "object", "title": "Exclusions" }, "selection_count": { "type": "integer", "title": "Selection Count" }, "deliverable_count": { "type": "integer", "title": "Deliverable Count" }, "billable_units": { "type": "integer", "title": "Billable Units" }, "max_amount_minor": { "type": "integer", "title": "Max Amount Minor" }, "currency": { "type": "string", "const": "usd", "title": "Currency", "default": "usd" }, "digest": { "type": "string", "title": "Digest" } }, "additionalProperties": false, "type": "object", "required": [ "selection_count", "deliverable_count", "billable_units", "max_amount_minor", "digest" ], "title": "ReviewSummary" }, "ReviewView": { "properties": { "id": { "type": "string", "title": "Id" }, "state": { "type": "string", "enum": [ "preparing", "ready", "held", "failed", "cancelled", "expired" ], "title": "State" }, "revision": { "type": "integer", "title": "Revision" }, "entity_type": { "type": "string", "enum": [ "person", "company" ], "title": "Entity Type" }, "parameters": { "$ref": "#/components/schemas/RecordedReviewCreate" }, "total_rows": { "type": "integer", "title": "Total Rows" }, "processed_rows": { "type": "integer", "title": "Processed Rows" }, "summary": { "anyOf": [ { "$ref": "#/components/schemas/ReviewSummary" }, { "type": "null" } ] }, "policy": { "anyOf": [ { "$ref": "#/components/schemas/DataPolicy" }, { "type": "null" } ] }, "created_at": { "type": "string", "title": "Created At" }, "updated_at": { "type": "string", "title": "Updated At" }, "expires_at": { "type": "string", "title": "Expires At" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" }, "can_confirm": { "type": "boolean", "title": "Can Confirm", "default": false }, "order_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Id" }, "can_confirm_job": { "type": "boolean", "title": "Can Confirm Job", "default": false }, "delivery_job_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Delivery Job Id" } }, "additionalProperties": false, "type": "object", "required": [ "id", "state", "revision", "entity_type", "parameters", "total_rows", "processed_rows", "summary", "policy", "created_at", "updated_at", "expires_at", "reason" ], "title": "ReviewView" }, "ReviewedCapacity": { "properties": { "quote_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Quote Id" }, "capacity_operation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Capacity Operation" }, "period_seconds": { "type": "integer", "title": "Period Seconds" }, "rate_cents_per_block": { "type": "integer", "title": "Rate Cents Per Block" }, "rate_version": { "type": "string", "title": "Rate Version" }, "maximum_new_capacity_cents": { "type": "integer", "title": "Maximum New Capacity Cents" }, "daily_capacity": { "type": "integer", "title": "Daily Capacity" }, "expires_at": { "type": "number", "title": "Expires At" }, "renewal": { "$ref": "#/components/schemas/ReviewedRenewal" }, "billing_mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Billing Mode" }, "sending_pool": { "anyOf": [ { "type": "string", "enum": [ "mailbox", "transactional", "all" ] }, { "type": "null" } ], "title": "Sending Pool" } }, "additionalProperties": false, "type": "object", "required": [ "quote_id", "capacity_operation", "period_seconds", "rate_cents_per_block", "rate_version", "maximum_new_capacity_cents", "daily_capacity", "expires_at", "renewal" ], "title": "ReviewedCapacity" }, "ReviewedCard": { "properties": { "brand": { "type": "string", "enum": [ "amex", "diners", "discover", "eftpos_au", "jcb", "link", "mastercard", "unionpay", "visa", "unknown" ], "title": "Brand" }, "last4": { "type": "string", "pattern": "^[0-9]{4}$", "title": "Last4" } }, "additionalProperties": false, "type": "object", "required": [ "brand", "last4" ], "title": "ReviewedCard" }, "ReviewedRenewal": { "properties": { "enabled": { "type": "boolean", "title": "Enabled" }, "recurring_max_cents": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Recurring Max Cents" }, "revision": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Revision" }, "keep_idle": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Keep Idle" }, "budget_cents": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Budget Cents" } }, "additionalProperties": false, "type": "object", "required": [ "enabled" ], "title": "ReviewedRenewal" }, "ReviewedSchedule": { "properties": { "definition": { "type": "string", "const": "campaign-pacing-upper-bound-v1", "title": "Definition" }, "observed_at": { "type": "number", "title": "Observed At" }, "local_date": { "type": "string", "title": "Local Date" }, "timezone": { "type": "string", "title": "Timezone" }, "first_eligible_at": { "type": "number", "title": "First Eligible At" }, "opens_at": { "type": "number", "title": "Opens At" }, "closes_at": { "type": "number", "title": "Closes At" }, "nominal_gap_seconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Nominal Gap Seconds" }, "daily_limit": { "type": "integer", "title": "Daily Limit" }, "quota_used": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Quota Used" }, "quota_remaining": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Quota Remaining" }, "pacing_slots_upper_bound": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Pacing Slots Upper Bound" }, "completion_guaranteed": { "type": "boolean", "const": false, "title": "Completion Guaranteed" } }, "additionalProperties": false, "type": "object", "required": [ "definition", "observed_at", "local_date", "timezone", "first_eligible_at", "opens_at", "closes_at", "nominal_gap_seconds", "daily_limit", "quota_used", "quota_remaining", "pacing_slots_upper_bound", "completion_guaranteed" ], "title": "ReviewedSchedule" }, "ReviewedSourceIntake": { "properties": { "parameters": { "$ref": "#/components/schemas/RefillConsentIn" }, "sources": { "items": { "$ref": "#/components/schemas/CampaignSource" }, "type": "array", "maxItems": 50, "minItems": 1, "title": "Sources" } }, "additionalProperties": false, "type": "object", "required": [ "parameters", "sources" ], "title": "ReviewedSourceIntake" }, "SaveCompanySource": { "properties": { "COMPANY_ID": { "type": "string", "maxLength": 256, "minLength": 1, "pattern": "^[^\\x00-\\x1f\\x7f]+$", "title": "Company Id" }, "target": { "anyOf": [ { "$ref": "#/components/schemas/SourceTarget" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "required": [ "COMPANY_ID" ], "title": "SaveCompanySource" }, "SavePersonSource": { "properties": { "UUID": { "type": "string", "maxLength": 256, "minLength": 1, "pattern": "^[^\\x00-\\x1f\\x7f]+$", "title": "Uuid" }, "target": { "anyOf": [ { "$ref": "#/components/schemas/SourceTarget" }, { "type": "null" } ], "description": "Explicitly attach to this active manual record; never infer a merge from matching contact fields." } }, "additionalProperties": false, "type": "object", "required": [ "UUID" ], "title": "SavePersonSource" }, "SaveResult": { "properties": { "operation": { "$ref": "#/components/schemas/Receipt" }, "reconciliation": { "$ref": "#/components/schemas/Reconciliation" }, "completion_semantics": { "type": "string", "const": "saved_not_launched_or_all_copy_ready", "title": "Completion Semantics" } }, "additionalProperties": false, "type": "object", "required": [ "operation", "reconciliation", "completion_semantics" ], "title": "SaveResult" }, "SavedCampaignDefinition": { "properties": { "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/SavedStep" }, "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", "description": "Finite campaign outbound sends per local sending day. Zero means unallocated: no new outbound sends or automatic preparation. The selected sending pool, shared capacity and current safeguards still apply.", "default": 0 }, "sending_pool": { "type": "string", "enum": [ "mailbox", "transactional", "all" ], "title": "Sending Pool", "description": "Authorized sending capacity: mailbox by default, transactional or all only with an admin grant. Does not classify message content.", "default": "mailbox" }, "allow_catch_all": { "type": "boolean", "title": "Allow Catch All", "default": false }, "template_format": { "type": "integer", "maximum": 2.0, "minimum": 1.0, "title": "Template Format", "default": 1 }, "name_cleaning": { "anyOf": [ { "$ref": "#/components/schemas/NameMapping" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "required": [ "name", "steps" ], "title": "SavedCampaignDefinition" }, "SavedCard": { "properties": { "id": { "type": "string", "title": "Id" }, "brand": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Brand" }, "last4": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last4" }, "exp_month": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Exp Month" }, "exp_year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Exp Year" } }, "additionalProperties": false, "type": "object", "required": [ "id", "brand", "last4", "exp_month", "exp_year" ], "title": "SavedCard" }, "SavedCards": { "properties": { "items": { "items": { "$ref": "#/components/schemas/SavedCard" }, "type": "array", "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "revision": { "type": "integer", "title": "Revision" }, "default_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Default Method" }, "pending_removal": { "anyOf": [ { "$ref": "#/components/schemas/CardRemovalOriginal" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "required": [ "items", "next_cursor", "revision", "default_method" ], "title": "SavedCards" }, "SavedRecordLink": { "properties": { "id": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Id" }, "revision": { "type": "integer", "title": "Revision" }, "state": { "type": "string", "enum": [ "active", "archived" ], "title": "State" }, "data_access": { "type": "string", "enum": [ "preview_only", "user_provided", "licensed" ], "title": "Data Access" }, "freshness": { "anyOf": [ { "type": "string", "enum": [ "current", "update_available", "unavailable" ] }, { "type": "null" } ], "title": "Freshness" }, "checked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Checked At" } }, "additionalProperties": false, "type": "object", "required": [ "id", "revision", "state", "data_access" ], "title": "SavedRecordLink" }, "SavedSearchCreate": { "properties": { "name": { "type": "string", "maxLength": 200, "minLength": 1, "title": "Name" }, "entity_type": { "type": "string", "enum": [ "person", "company" ], "title": "Entity Type" }, "query": { "$ref": "#/components/schemas/SearchQuery-Input" } }, "additionalProperties": false, "type": "object", "required": [ "name", "entity_type", "query" ], "title": "SavedSearchCreate" }, "SavedSearchEdit": { "properties": { "expected_revision": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Expected Revision" }, "state": { "anyOf": [ { "type": "string", "enum": [ "active", "archived" ] }, { "type": "null" } ], "title": "State" }, "name": { "anyOf": [ { "type": "string", "maxLength": 200, "minLength": 1 }, { "type": "null" } ], "title": "Name" }, "query": { "anyOf": [ { "$ref": "#/components/schemas/SearchQuery-Input" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "required": [ "expected_revision" ], "title": "SavedSearchEdit" }, "SavedSearchView": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "entity_type": { "type": "string", "enum": [ "person", "company" ], "title": "Entity Type" }, "state": { "type": "string", "enum": [ "active", "archived" ], "title": "State" }, "revision": { "type": "integer", "title": "Revision" }, "query": { "$ref": "#/components/schemas/SearchQuery-Output" }, "mapping_digest": { "type": "string", "title": "Mapping Digest" }, "validation": { "type": "string", "enum": [ "current", "revalidation_required", "unavailable" ], "title": "Validation" }, "created_at": { "type": "string", "title": "Created At" }, "updated_at": { "type": "string", "title": "Updated At" } }, "type": "object", "required": [ "id", "name", "entity_type", "state", "revision", "query", "mapping_digest", "validation", "created_at", "updated_at" ], "title": "SavedSearchView" }, "SavedStep": { "properties": { "id": { "type": "integer", "minimum": 0.0, "title": "Id", "description": "Stable campaign-local identity, independent of array position. Never reused." }, "subject": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "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": [ "id", "body" ], "title": "SavedStep" }, "ScheduleAdviceCoverage": { "properties": { "horizon_end": { "type": "number", "title": "Horizon End" }, "complete": { "type": "boolean", "title": "Complete", "default": false }, "peer_definitions": { "type": "integer", "title": "Peer Definitions", "default": 0 }, "roster": { "type": "integer", "title": "Roster", "default": 0 }, "virtual_allocations": { "type": "integer", "title": "Virtual Allocations", "default": 0 }, "maximum_virtual_allocations": { "type": "integer", "const": 4000, "title": "Maximum Virtual Allocations", "default": 4000 }, "maximum_evaluation_ms": { "type": "integer", "const": 150, "title": "Maximum Evaluation Ms", "default": 150 } }, "additionalProperties": false, "type": "object", "required": [ "horizon_end" ], "title": "ScheduleAdviceCoverage" }, "ScheduleAdviceDraft": { "properties": { "kind": { "type": "string", "const": "draft", "title": "Kind" }, "key": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Key" }, "schedule": { "$ref": "#/components/schemas/Window" }, "daily_limit": { "type": "integer", "maximum": 15000.0, "minimum": 0.0, "title": "Daily Limit" }, "sending_pool": { "type": "string", "enum": [ "mailbox", "transactional", "all" ], "title": "Sending Pool", "default": "mailbox" } }, "additionalProperties": false, "type": "object", "required": [ "kind", "key", "schedule", "daily_limit" ], "title": "ScheduleAdviceDraft" }, "ScheduleAdviceInterval": { "properties": { "opens_at": { "type": "number", "title": "Opens At" }, "closes_at": { "type": "number", "title": "Closes At" } }, "additionalProperties": false, "type": "object", "required": [ "opens_at", "closes_at" ], "title": "ScheduleAdviceInterval" }, "ScheduleAdviceIssue": { "properties": { "code": { "type": "string", "title": "Code" }, "severity": { "type": "string", "enum": [ "info", "warning" ], "title": "Severity", "default": "warning" } }, "additionalProperties": false, "type": "object", "required": [ "code" ], "title": "ScheduleAdviceIssue" }, "ScheduleAdviceItem": { "properties": { "kind": { "type": "string", "enum": [ "draft", "saved" ], "title": "Kind" }, "key": { "type": "string", "title": "Key" }, "campaign": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Campaign" }, "revision": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Revision" }, "input_fingerprint": { "type": "string", "title": "Input Fingerprint" }, "schedule": { "anyOf": [ { "$ref": "#/components/schemas/Window" }, { "type": "null" } ] }, "daily_limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Daily Limit" }, "sending_pool": { "anyOf": [ { "type": "string", "enum": [ "mailbox", "transactional", "all" ] }, { "type": "null" } ], "title": "Sending Pool" }, "state": { "type": "string", "enum": [ "ready", "partial", "unavailable" ], "title": "State", "default": "unavailable" }, "window": { "anyOf": [ { "$ref": "#/components/schemas/ScheduleAdviceWindow" }, { "type": "null" } ] }, "theoretical_opportunities": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Theoretical Opportunities" }, "shortfall": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Shortfall" }, "issues": { "items": { "$ref": "#/components/schemas/ScheduleAdviceIssue" }, "type": "array", "title": "Issues" }, "recommendations": { "items": { "$ref": "#/components/schemas/ScheduleAdviceRecommendation" }, "type": "array", "maxItems": 3, "title": "Recommendations" } }, "additionalProperties": false, "type": "object", "required": [ "kind", "key", "campaign", "revision", "input_fingerprint", "schedule", "daily_limit", "sending_pool" ], "title": "ScheduleAdviceItem" }, "ScheduleAdviceRecommendation": { "properties": { "schedule": { "$ref": "#/components/schemas/Window" }, "window": { "$ref": "#/components/schemas/ScheduleAdviceWindow" }, "theoretical_opportunities": { "type": "integer", "title": "Theoretical Opportunities" }, "shortfall": { "type": "integer", "const": 0, "title": "Shortfall", "default": 0 }, "selection": { "type": "string", "enum": [ "shortest_evaluated_sufficient", "evaluated_sufficient" ], "title": "Selection" } }, "additionalProperties": false, "type": "object", "required": [ "schedule", "window", "theoretical_opportunities", "selection" ], "title": "ScheduleAdviceRecommendation" }, "ScheduleAdviceRequest": { "properties": { "items": { "items": { "oneOf": [ { "$ref": "#/components/schemas/ScheduleAdviceDraft" }, { "$ref": "#/components/schemas/ScheduleAdviceSaved" } ], "discriminator": { "propertyName": "kind", "mapping": { "draft": "#/components/schemas/ScheduleAdviceDraft", "saved": "#/components/schemas/ScheduleAdviceSaved" } } }, "type": "array", "maxItems": 50, "minItems": 1, "title": "Items" } }, "additionalProperties": false, "type": "object", "required": [ "items" ], "title": "ScheduleAdviceRequest" }, "ScheduleAdviceResponse": { "properties": { "definition": { "type": "string", "const": "schedule-advice-v1", "title": "Definition", "default": "schedule-advice-v1" }, "state": { "type": "string", "enum": [ "ready", "partial", "unavailable" ], "title": "State", "default": "unavailable" }, "observed_at": { "type": "number", "title": "Observed At" }, "expires_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Expires At" }, "fingerprint": { "type": "string", "title": "Fingerprint", "default": "" }, "coverage": { "$ref": "#/components/schemas/ScheduleAdviceCoverage" }, "issues": { "items": { "$ref": "#/components/schemas/ScheduleAdviceIssue" }, "type": "array", "title": "Issues" }, "items": { "items": { "$ref": "#/components/schemas/ScheduleAdviceItem" }, "type": "array", "maxItems": 50, "title": "Items" }, "semantics": { "type": "string", "const": "configuration_fit_not_queue_readiness_or_reservation", "title": "Semantics", "default": "configuration_fit_not_queue_readiness_or_reservation" }, "assumptions": { "items": { "type": "string" }, "type": "array", "title": "Assumptions" } }, "additionalProperties": false, "type": "object", "required": [ "observed_at", "coverage", "items" ], "title": "ScheduleAdviceResponse" }, "ScheduleAdviceSaved": { "properties": { "kind": { "type": "string", "const": "saved", "title": "Kind" }, "campaign": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Campaign" }, "expected_revision": { "type": "integer", "minimum": 1.0, "title": "Expected Revision" }, "schedule": { "anyOf": [ { "$ref": "#/components/schemas/Window" }, { "type": "null" } ] }, "daily_limit": { "anyOf": [ { "type": "integer", "maximum": 15000.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Daily Limit" }, "sending_pool": { "anyOf": [ { "type": "string", "enum": [ "mailbox", "transactional", "all" ] }, { "type": "null" } ], "title": "Sending Pool" } }, "additionalProperties": false, "type": "object", "required": [ "kind", "campaign", "expected_revision" ], "title": "ScheduleAdviceSaved" }, "ScheduleAdviceWindow": { "properties": { "local_date": { "type": "string", "title": "Local Date" }, "timezone": { "type": "string", "title": "Timezone" }, "opens_at": { "type": "number", "title": "Opens At" }, "closes_at": { "type": "number", "title": "Closes At" }, "intervals": { "items": { "$ref": "#/components/schemas/ScheduleAdviceInterval" }, "type": "array", "title": "Intervals" } }, "additionalProperties": false, "type": "object", "required": [ "local_date", "timezone", "opens_at", "closes_at", "intervals" ], "title": "ScheduleAdviceWindow" }, "ScheduleChangeReceipt": { "properties": { "id": { "type": "string", "title": "Id" }, "campaign": { "type": "string", "title": "Campaign" }, "revision": { "type": "integer", "minimum": 1.0, "title": "Revision", "description": "Campaign revision accepted by this original, not the current campaign revision." }, "schedule": { "type": "string", "title": "Schedule", "description": "Original JSON-encoded window with timezone, weekdays, start and end. Retains the existing string wire format." }, "daily_limit": { "type": "integer", "minimum": 0.0, "title": "Daily Limit" }, "limit_semantics": { "type": "string", "enum": [ "uncapped_zero", "finite" ], "title": "Limit Semantics", "description": "Meaning captured by this original: pre-cutover zero was uncapped; finite zero is unallocated." }, "sending_pool": { "anyOf": [ { "type": "string", "enum": [ "mailbox", "transactional", "all" ] }, { "type": "null" } ], "title": "Sending Pool", "description": "Selected capacity pool; null only for originals created before pool selection existed." }, "allow_catch_all": { "type": "boolean", "title": "Allow Catch All" }, "not_before": { "type": "number", "title": "Not Before", "description": "Admission barrier in Unix seconds; zero means no additional barrier. Not a promised send time." }, "phase": { "type": "string", "enum": [ "jobs", "preparations", "complete" ], "title": "Phase" }, "processed": { "type": "integer", "minimum": 0.0, "title": "Processed", "description": "Job and preparation rows examined across replan phases. Not unique recipients, changed rows or a total." }, "created_at": { "type": "number", "title": "Created At", "description": "Original acceptance time, Unix seconds." }, "completed_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Completed At", "description": "Replan completion or supersession time, Unix seconds; null while pending. Does not start or resume the campaign." }, "superseded_by": { "type": "string", "title": "Superseded By", "description": "Newer schedule change that took over unfinished reconciliation; empty otherwise." } }, "additionalProperties": false, "type": "object", "required": [ "id", "campaign", "revision", "schedule", "daily_limit", "limit_semantics", "sending_pool", "allow_catch_all", "not_before", "phase", "processed", "created_at", "completed_at", "superseded_by" ], "title": "ScheduleChangeReceipt", "examples": [ { "allow_catch_all": false, "campaign": "example-campaign", "created_at": 1791590400.0, "daily_limit": 20, "id": "schedule-edit", "limit_semantics": "finite", "not_before": 0.0, "phase": "jobs", "processed": 100, "revision": 4, "schedule": "{\"timezone\":\"UTC\",\"weekdays\":[0,1,2,3,4],\"start\":\"09:00\",\"end\":\"17:00\"}", "superseded_by": "" }, { "allow_catch_all": false, "campaign": "example-campaign", "completed_at": 1791590402.0, "created_at": 1791590400.0, "daily_limit": 20, "id": "schedule-edit", "limit_semantics": "finite", "not_before": 0.0, "phase": "complete", "processed": 125, "revision": 4, "schedule": "{\"timezone\":\"UTC\",\"weekdays\":[0,1,2,3,4],\"start\":\"09:00\",\"end\":\"17:00\"}", "superseded_by": "" } ] }, "SearchItem": { "properties": { "preview": { "anyOf": [ { "$ref": "#/components/schemas/PersonPreview" }, { "$ref": "#/components/schemas/CompanyPreview" } ], "title": "Preview" }, "data_access": { "type": "string", "const": "preview_only", "title": "Data Access" }, "availability": { "anyOf": [ { "$ref": "#/components/schemas/PersonAvailability" }, { "$ref": "#/components/schemas/CompanyAvailability" } ], "title": "Availability" }, "saved_record": { "anyOf": [ { "$ref": "#/components/schemas/SavedRecordLink" }, { "type": "null" } ] } }, "type": "object", "required": [ "preview", "data_access", "availability" ], "title": "SearchItem" }, "SearchNext": { "properties": { "data_source": { "type": "string", "enum": [ "people", "companies" ], "title": "Data Source", "default": "people" }, "cursor": { "type": "string", "maxLength": 65536, "minLength": 1, "title": "Cursor" }, "size": { "type": "integer", "maximum": 200.0, "minimum": 1.0, "title": "Size", "default": 25 } }, "additionalProperties": false, "type": "object", "required": [ "cursor" ], "title": "SearchNext" }, "SearchPage": { "properties": { "hits": { "items": { "anyOf": [ { "$ref": "#/components/schemas/PersonPreview" }, { "$ref": "#/components/schemas/CompanyPreview" } ] }, "type": "array", "title": "Hits" }, "data_source": { "type": "string", "enum": [ "people", "companies" ], "title": "Data Source" }, "size": { "type": "integer", "title": "Size" }, "offset": { "type": "integer", "title": "Offset" }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total" }, "count_status": { "type": "string", "enum": [ "exact", "not_requested", "unavailable" ], "title": "Count Status" }, "query_time_ms": { "type": "integer", "title": "Query Time Ms" }, "saved_records": { "additionalProperties": { "$ref": "#/components/schemas/SavedRecordLink" }, "type": "object", "title": "Saved Records" }, "saved_records_available": { "type": "boolean", "title": "Saved Records Available" }, "result_set_id": { "type": "string", "title": "Result Set Id" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "expires_at": { "type": "string", "title": "Expires At" } }, "type": "object", "required": [ "hits", "data_source", "size", "offset", "total", "count_status", "query_time_ms", "saved_records", "saved_records_available", "result_set_id", "next_cursor", "expires_at" ], "title": "SearchPage" }, "SearchQuery-Input": { "properties": { "data_source": { "type": "string", "enum": [ "people", "companies" ], "title": "Data Source", "default": "people" }, "ownership": { "type": "string", "enum": [ "all", "net_new", "saved" ], "title": "Ownership", "default": "all" }, "query": { "type": "string", "maxLength": 240, "pattern": "^[^\\x00-\\x1f\\x7f]*$", "title": "Query", "default": "" }, "keyword_mode": { "type": "string", "enum": [ "AND", "OR", "phrase" ], "title": "Keyword Mode", "default": "AND" }, "filters": { "additionalProperties": { "oneOf": [ { "$ref": "#/components/schemas/Keywords" }, { "$ref": "#/components/schemas/Picklist" }, { "$ref": "#/components/schemas/Presence" }, { "$ref": "#/components/schemas/Range" }, { "$ref": "#/components/schemas/Nested-Input" } ], "discriminator": { "propertyName": "type", "mapping": { "exists": "#/components/schemas/Presence", "keyword_group": "#/components/schemas/Keywords", "nested": "#/components/schemas/Nested-Input", "picklist": "#/components/schemas/Picklist", "range": "#/components/schemas/Range" } } }, "type": "object", "maxProperties": 50, "title": "Filters" }, "sort": { "items": { "$ref": "#/components/schemas/Sort" }, "type": "array", "maxItems": 2, "title": "Sort" }, "size": { "type": "integer", "maximum": 200.0, "minimum": 1.0, "title": "Size", "default": 25 }, "count": { "type": "string", "enum": [ "exact", "none" ], "title": "Count", "default": "exact" }, "domain_sets": { "anyOf": [ { "$ref": "#/components/schemas/DomainSetFilters" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "title": "SearchQuery" }, "SearchQuery-Output": { "properties": { "data_source": { "type": "string", "enum": [ "people", "companies" ], "title": "Data Source", "default": "people" }, "ownership": { "type": "string", "enum": [ "all", "net_new", "saved" ], "title": "Ownership", "default": "all" }, "query": { "type": "string", "maxLength": 240, "pattern": "^[^\\x00-\\x1f\\x7f]*$", "title": "Query", "default": "" }, "keyword_mode": { "type": "string", "enum": [ "AND", "OR", "phrase" ], "title": "Keyword Mode", "default": "AND" }, "filters": { "additionalProperties": { "oneOf": [ { "$ref": "#/components/schemas/Keywords" }, { "$ref": "#/components/schemas/Picklist" }, { "$ref": "#/components/schemas/Presence" }, { "$ref": "#/components/schemas/Range" }, { "$ref": "#/components/schemas/Nested-Output" } ], "discriminator": { "propertyName": "type", "mapping": { "exists": "#/components/schemas/Presence", "keyword_group": "#/components/schemas/Keywords", "nested": "#/components/schemas/Nested-Output", "picklist": "#/components/schemas/Picklist", "range": "#/components/schemas/Range" } } }, "type": "object", "maxProperties": 50, "title": "Filters" }, "sort": { "items": { "$ref": "#/components/schemas/Sort" }, "type": "array", "maxItems": 2, "title": "Sort" }, "size": { "type": "integer", "maximum": 200.0, "minimum": 1.0, "title": "Size", "default": 25 }, "count": { "type": "string", "enum": [ "exact", "none" ], "title": "Count", "default": "exact" }, "domain_sets": { "anyOf": [ { "$ref": "#/components/schemas/DomainSetFilters" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "title": "SearchQuery" }, "SearchRateLimit": { "properties": { "detail": { "anyOf": [ { "$ref": "#/components/schemas/SearchRateLimitDetail" }, { "type": "string" } ], "title": "Detail" } }, "additionalProperties": false, "type": "object", "required": [ "detail" ], "title": "SearchRateLimit" }, "SearchRateLimitDetail": { "properties": { "code": { "type": "string", "enum": [ "search_daily_budget_exhausted", "search_capacity_unavailable", "search_snapshot_limit" ], "title": "Code" } }, "additionalProperties": false, "type": "object", "required": [ "code" ], "title": "SearchRateLimitDetail" }, "SelectionParameters": { "properties": { "kind": { "type": "string", "title": "Kind" }, "entity_type": { "type": "string", "enum": [ "person", "company" ], "title": "Entity Type" }, "max_records": { "type": "integer", "title": "Max Records" }, "max_per_company": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Per Company" }, "list_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "List Id" }, "expected_membership_revision": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Expected Membership Revision" }, "record_filter": { "anyOf": [ { "$ref": "#/components/schemas/RecordSelectionFilter" }, { "type": "null" } ] } }, "additionalProperties": { "$ref": "#/components/schemas/JsonValue" }, "type": "object", "required": [ "kind", "entity_type", "max_records" ], "title": "SelectionParameters" }, "SelectionPreviewPage": { "properties": { "hits": { "items": { "anyOf": [ { "$ref": "#/components/schemas/PersonPreview" }, { "$ref": "#/components/schemas/CompanyPreview" } ] }, "type": "array", "title": "Hits" }, "data_source": { "type": "string", "enum": [ "people", "companies" ], "title": "Data Source" }, "total": { "type": "integer", "title": "Total" }, "result_set_id": { "type": "string", "title": "Result Set Id" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "expires_at": { "type": "string", "title": "Expires At" } }, "additionalProperties": false, "type": "object", "required": [ "hits", "data_source", "total", "result_set_id", "next_cursor", "expires_at" ], "title": "SelectionPreviewPage" }, "SelectionView": { "properties": { "id": { "type": "string", "title": "Id" }, "parameters": { "$ref": "#/components/schemas/SelectionParameters", "description": "Original scope. New selections must use SelectionCreate; reading history never reinterprets or authorizes it." }, "state": { "type": "string", "enum": [ "preparing", "ready", "failed", "cancelled", "expired" ], "title": "State" }, "import_id": { "type": "string", "title": "Import Id" }, "source_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Source Count" }, "source_count_relation": { "type": "string", "enum": [ "eq", "gte", "unknown" ], "title": "Source Count Relation", "default": "eq" }, "selected_rows": { "type": "integer", "title": "Selected Rows" }, "scanned_rows": { "type": "integer", "title": "Scanned Rows", "default": 0 }, "valid_rows": { "type": "integer", "title": "Valid Rows" }, "invalid_rows": { "type": "integer", "title": "Invalid Rows" }, "limited": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Limited" }, "digest": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Digest" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" }, "created_at": { "type": "string", "title": "Created At" }, "updated_at": { "type": "string", "title": "Updated At" }, "expires_at": { "type": "string", "title": "Expires At" } }, "type": "object", "required": [ "id", "parameters", "state", "import_id", "source_count", "selected_rows", "valid_rows", "invalid_rows", "limited", "digest", "reason", "created_at", "updated_at", "expires_at" ], "title": "SelectionView" }, "SendCounts": { "properties": { "first_touches": { "type": "integer", "title": "First Touches" }, "followups": { "type": "integer", "title": "Followups" } }, "type": "object", "required": [ "first_touches", "followups" ], "title": "SendCounts" }, "SendDetail": { "properties": { "recipient": { "type": "string", "title": "Recipient" }, "step": { "type": "integer", "title": "Step" }, "sequence_position": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sequence Position" }, "sequence_total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sequence Total" }, "state": { "type": "string", "title": "State" }, "due_at": { "type": "number", "title": "Due At" }, "updated_at": { "type": "number", "title": "Updated At" }, "campaign_state": { "type": "string", "title": "Campaign State" }, "enrollment_state": { "type": "string", "title": "Enrollment State" }, "content": { "anyOf": [ { "$ref": "#/components/schemas/MessageCopy" }, { "type": "null" } ] }, "preparation_state": { "type": "string", "title": "Preparation State" }, "transformer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Transformer" }, "quality_check": { "type": "string", "title": "Quality Check" }, "verification": { "$ref": "#/components/schemas/VerificationView" }, "observed_at": { "type": "number", "title": "Observed At" } }, "type": "object", "required": [ "recipient", "step", "sequence_position", "sequence_total", "state", "due_at", "updated_at", "campaign_state", "enrollment_state", "content", "preparation_state", "transformer", "quality_check", "verification", "observed_at" ], "title": "SendDetail" }, "SendProjectionSummary": { "properties": { "definition": { "type": "string", "const": "send-projection-v1", "title": "Definition", "default": "send-projection-v1" }, "state": { "type": "string", "enum": [ "ready", "partial", "unavailable" ], "title": "State", "default": "ready" }, "observed_at": { "type": "number", "title": "Observed At" }, "as_of": { "type": "number", "title": "As Of" }, "horizon_end": { "type": "number", "title": "Horizon End" }, "timezone": { "type": "string", "title": "Timezone" }, "complete": { "type": "boolean", "title": "Complete", "default": true }, "reason": { "type": "string", "title": "Reason", "default": "" }, "fingerprint": { "type": "string", "title": "Fingerprint", "default": "" }, "days": { "items": { "$ref": "#/components/schemas/ProjectedDay" }, "type": "array", "title": "Days" }, "campaigns": { "items": { "$ref": "#/components/schemas/CampaignProjection" }, "type": "array", "title": "Campaigns" }, "insights": { "items": { "$ref": "#/components/schemas/Insight" }, "type": "array", "title": "Insights" }, "assumptions": { "items": { "type": "string" }, "type": "array", "title": "Assumptions" } }, "additionalProperties": false, "type": "object", "required": [ "observed_at", "as_of", "horizon_end", "timezone" ], "title": "SendProjectionSummary" }, "SenderIdentity": { "properties": { "mailbox": { "type": "string", "title": "Mailbox" }, "revision": { "type": "integer", "title": "Revision" }, "full_name": { "type": "string", "title": "Full Name" }, "job_title": { "type": "string", "title": "Job Title" } }, "additionalProperties": false, "type": "object", "required": [ "mailbox", "revision", "full_name", "job_title" ], "title": "SenderIdentity" }, "SenderIdentityPage": { "properties": { "items": { "items": { "$ref": "#/components/schemas/EffectiveSenderIdentity" }, "type": "array", "maxItems": 100, "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "local_parts": { "items": { "$ref": "#/components/schemas/SenderIdentity" }, "type": "array", "maxItems": 100, "title": "Local Parts" }, "default_identity": { "$ref": "#/components/schemas/SenderIdentity" } }, "additionalProperties": false, "type": "object", "required": [ "items", "next_cursor", "local_parts", "default_identity" ], "title": "SenderIdentityPage" }, "SenderProfile": { "properties": { "workspace": { "type": "string", "title": "Workspace" }, "sender": { "type": "string", "title": "Sender" }, "revision": { "type": "integer", "title": "Revision" }, "business_name": { "type": "string", "title": "Business Name" }, "postal_address": { "type": "string", "title": "Postal Address" }, "enabled": { "type": "integer", "enum": [ 0, 1 ], "title": "Enabled" }, "actor": { "type": "string", "title": "Actor" }, "created_at": { "type": "number", "title": "Created At" } }, "additionalProperties": false, "type": "object", "required": [ "workspace", "sender", "revision", "business_name", "postal_address", "enabled", "actor", "created_at" ], "title": "SenderProfile" }, "SendingOutlook": { "properties": { "forecast": { "anyOf": [ { "$ref": "#/components/schemas/SendProjectionSummary" }, { "type": "null" } ] }, "definition": { "type": "string", "const": "sending-outlook-v1", "title": "Definition", "default": "sending-outlook-v1" }, "state": { "type": "string", "enum": [ "ready", "unavailable" ], "title": "State" }, "observed_at": { "type": "number", "title": "Observed At" }, "timezone": { "type": "string", "title": "Timezone" }, "local_date": { "type": "string", "title": "Local Date" }, "accepted": { "$ref": "#/components/schemas/SendCounts" }, "accepted_replies": { "type": "integer", "title": "Accepted Replies" }, "paid_limit": { "type": "integer", "title": "Paid Limit" }, "mailbox_limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Mailbox Limit" }, "capacity_ceiling": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Capacity Ceiling" }, "configured_limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Configured Limit" }, "maximum": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Maximum" }, "remaining_maximum": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Remaining Maximum" }, "capacity_gap": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Capacity Gap" }, "carry_forward_at_least": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Carry Forward At Least" }, "has_window_today": { "type": "boolean", "title": "Has Window Today" }, "reason": { "type": "string", "title": "Reason" }, "campaigns": { "items": { "$ref": "#/components/schemas/CampaignOutlook" }, "type": "array", "title": "Campaigns" }, "semantics": { "type": "string", "const": "upper_bound_not_a_booking_or_delivery_promise", "title": "Semantics", "default": "upper_bound_not_a_booking_or_delivery_promise" } }, "type": "object", "required": [ "state", "observed_at", "timezone", "local_date", "accepted", "accepted_replies", "paid_limit", "mailbox_limit", "capacity_ceiling", "configured_limit", "maximum", "remaining_maximum", "capacity_gap", "carry_forward_at_least", "has_window_today", "reason", "campaigns" ], "title": "SendingOutlook" }, "SendingPolicyOperation": { "properties": { "id": { "type": "string", "title": "Id" }, "state": { "type": "string", "enum": [ "pending", "replanning", "complete", "failed" ], "title": "State" }, "requested_slow_ramp": { "type": "boolean", "title": "Requested Slow Ramp" }, "expected_revision": { "type": "integer", "title": "Expected Revision" }, "receipt": { "anyOf": [ { "$ref": "#/components/schemas/LegacySendingPolicyReceipt" }, { "type": "null" } ] }, "error": { "type": "string", "title": "Error" }, "created_at": { "type": "number", "title": "Created At" }, "completed_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Completed At" }, "processed": { "type": "integer", "title": "Processed" } }, "additionalProperties": false, "type": "object", "required": [ "id", "state", "requested_slow_ramp", "expected_revision", "receipt", "error", "created_at", "completed_at", "processed" ], "title": "SendingPolicyOperation" }, "SendingPoolAllocation": { "properties": { "pool": { "type": "string", "enum": [ "mailbox", "transactional", "all" ], "title": "Pool" }, "available": { "type": "integer", "minimum": 0.0, "title": "Available" }, "overage": { "type": "integer", "minimum": 0.0, "title": "Overage" } }, "additionalProperties": false, "type": "object", "required": [ "pool", "available", "overage" ], "title": "SendingPoolAllocation" }, "SendingPoolCapacity": { "properties": { "pool": { "type": "string", "enum": [ "mailbox", "transactional", "all" ], "title": "Pool" }, "daily_limit": { "type": "integer", "minimum": 0.0, "title": "Daily Limit" } }, "additionalProperties": false, "type": "object", "required": [ "pool", "daily_limit" ], "title": "SendingPoolCapacity" }, "ServiceInterval": { "properties": { "start": { "type": "string", "title": "Start" }, "end": { "type": "string", "title": "End" }, "daily_sends": { "type": "integer", "title": "Daily Sends" }, "kind": { "type": "string", "enum": [ "term", "addition", "renewal" ], "title": "Kind" } }, "additionalProperties": false, "type": "object", "required": [ "start", "end", "daily_sends", "kind" ], "title": "ServiceInterval" }, "SignupBonus": { "properties": { "card_bonus_minor": { "type": "integer", "maximum": 500.0, "minimum": 0.0, "title": "Card Bonus Minor" }, "card_bonus_state": { "type": "string", "enum": [ "ineligible", "pending", "awarded" ], "title": "Card Bonus State" } }, "type": "object", "required": [ "card_bonus_minor", "card_bonus_state" ], "title": "SignupBonus" }, "Sort": { "properties": { "field": { "type": "string", "maxLength": 256, "minLength": 1, "pattern": "^[^\\x00-\\x1f\\x7f]+$", "title": "Field" }, "direction": { "type": "string", "enum": [ "asc", "desc" ], "title": "Direction", "default": "asc" } }, "additionalProperties": false, "type": "object", "required": [ "field" ], "title": "Sort" }, "SourceCheck": { "properties": { "expected_revision": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Expected Revision" }, "expected_check_revision": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Expected Check Revision" } }, "additionalProperties": false, "type": "object", "required": [ "expected_revision", "expected_check_revision" ], "title": "SourceCheck" }, "SourceCheckHistory": { "properties": { "items": { "items": { "$ref": "#/components/schemas/SourceCheckObservation" }, "type": "array", "title": "Items" }, "next_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Next After" } }, "type": "object", "required": [ "items", "next_after" ], "title": "SourceCheckHistory" }, "SourceCheckObservation": { "properties": { "check_revision": { "type": "integer", "title": "Check Revision" }, "checked_at": { "type": "string", "title": "Checked At" }, "saved_version_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Saved Version Id" }, "latest_version_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Latest Version Id" }, "freshness": { "type": "string", "enum": [ "current", "update_available", "unavailable" ], "title": "Freshness" }, "supplier_hash_status": { "type": "string", "enum": [ "absent", "observed", "consistent", "drift" ], "title": "Supplier Hash Status" } }, "type": "object", "required": [ "check_revision", "checked_at", "saved_version_id", "latest_version_id", "freshness", "supplier_hash_status" ], "title": "SourceCheckObservation" }, "SourceCollection": { "properties": { "campaign_id": { "type": "string", "title": "Campaign Id" }, "campaign_revision": { "type": "integer", "title": "Campaign Revision" }, "sources_revision": { "type": "integer", "title": "Sources Revision" }, "max_sources": { "type": "integer", "title": "Max Sources", "default": 50 }, "admission_enabled": { "type": "boolean", "const": true, "title": "Admission Enabled", "default": true }, "admission_max_people": { "type": "integer", "title": "Admission Max People", "default": 200 }, "automatic_refill_enabled": { "type": "boolean", "const": true, "title": "Automatic Refill Enabled", "default": true }, "included_preparation_enabled": { "type": "boolean", "title": "Included Preparation Enabled", "default": false }, "included_unlock_enabled": { "type": "boolean", "title": "Included Unlock Enabled", "default": false }, "items": { "items": { "$ref": "#/components/schemas/CampaignSource" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "campaign_id", "campaign_revision", "sources_revision", "items" ], "title": "SourceCollection" }, "SourceComparison": { "properties": { "baseline_version_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Baseline Version Id" }, "observed_version_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Observed Version Id" }, "checked_at": { "type": "string", "title": "Checked At" }, "preview_fields": { "anyOf": [ { "items": { "type": "string", "enum": [ "UUID", "FIRST_NAME", "LAST_NAME", "PHOTO_URL", "COMPANY_NAME", "JOB_TITLE", "COMPANY_LOGO_URL", "PERSONAL_CITY", "PERSONAL_STATE", "PERSONAL_COUNTRY", "COMPANY_DOMAIN", "COMPANY_ID", "COMPANY_CITY", "COMPANY_STATE", "COMPANY_COUNTRY" ] }, "type": "array" }, { "type": "null" } ], "title": "Preview Fields" }, "employment": { "anyOf": [ { "$ref": "#/components/schemas/EmploymentComparison" }, { "type": "null" } ] } }, "type": "object", "required": [ "baseline_version_id", "observed_version_id", "checked_at", "preview_fields", "employment" ], "title": "SourceComparison" }, "SourceConnect": { "properties": { "expected_campaign_revision": { "type": "integer", "minimum": 1.0, "title": "Expected Campaign Revision" }, "expected_sources_revision": { "type": "integer", "minimum": 1.0, "title": "Expected Sources Revision" }, "list_id": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "List Id" } }, "additionalProperties": false, "type": "object", "required": [ "expected_campaign_revision", "expected_sources_revision", "list_id" ], "title": "SourceConnect" }, "SourceEdit": { "properties": { "expected_campaign_revision": { "type": "integer", "minimum": 1.0, "title": "Expected Campaign Revision" }, "expected_sources_revision": { "type": "integer", "minimum": 1.0, "title": "Expected Sources Revision" }, "expected_revision": { "type": "integer", "minimum": 1.0, "title": "Expected Revision" }, "state": { "type": "string", "enum": [ "connected", "disconnected" ], "title": "State" } }, "additionalProperties": false, "type": "object", "required": [ "expected_campaign_revision", "expected_sources_revision", "expected_revision", "state" ], "title": "SourceEdit" }, "SourceLookup": { "properties": { "ids": { "items": { "type": "string", "maxLength": 256, "minLength": 1, "pattern": "^[^\\x00-\\x1f\\x7f]+$" }, "type": "array", "maxItems": 100, "minItems": 1, "title": "Ids" }, "id_type": { "type": "string", "enum": [ "source", "record" ], "title": "Id Type", "default": "source" } }, "additionalProperties": false, "type": "object", "required": [ "ids" ], "title": "SourceLookup" }, "SourceOperation": { "properties": { "id": { "type": "string", "title": "Id" }, "campaign_id": { "type": "string", "title": "Campaign Id" }, "source_id": { "type": "string", "title": "Source Id" }, "revision": { "type": "integer", "title": "Revision" }, "sources_revision": { "type": "integer", "title": "Sources Revision" }, "state": { "type": "string", "const": "completed", "title": "State", "default": "completed" }, "created_at": { "type": "string", "title": "Created At" } }, "type": "object", "required": [ "id", "campaign_id", "source_id", "revision", "sources_revision", "created_at" ], "title": "SourceOperation" }, "SourceProgress": { "properties": { "source_id": { "type": "string", "title": "Source Id" }, "examined": { "type": "integer", "title": "Examined", "default": 0 }, "added": { "type": "integer", "title": "Added", "default": 0 }, "held": { "type": "integer", "title": "Held", "default": 0 }, "already_admitted": { "type": "integer", "title": "Already Admitted", "default": 0 }, "last_admission_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Admission Id" } }, "type": "object", "required": [ "source_id" ], "title": "SourceProgress" }, "SourceSelection": { "properties": { "list_ids": { "items": { "type": "string", "pattern": "^[a-f0-9]{32}$" }, "type": "array", "maxItems": 50, "title": "List Ids" }, "expected_sources_revision": { "type": "integer", "minimum": 1.0, "title": "Expected Sources Revision" } }, "additionalProperties": false, "type": "object", "required": [ "list_ids", "expected_sources_revision" ], "title": "SourceSelection" }, "SourceState": { "properties": { "freshness": { "type": "string", "enum": [ "current", "update_available", "unavailable" ], "title": "Freshness" }, "check_revision": { "type": "integer", "title": "Check Revision" }, "checked_at": { "type": "string", "title": "Checked At" }, "saved_version_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Saved Version Id" }, "latest_version_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Latest Version Id" }, "latest_preview": { "anyOf": [ { "$ref": "#/components/schemas/PersonPreview" }, { "$ref": "#/components/schemas/CompanyPreview" }, { "type": "null" } ], "title": "Latest Preview" }, "supplier_hash_status": { "type": "string", "enum": [ "absent", "observed", "consistent", "drift" ], "title": "Supplier Hash Status" }, "comparison": { "$ref": "#/components/schemas/SourceComparison" } }, "type": "object", "required": [ "freshness", "check_revision", "checked_at", "saved_version_id", "latest_version_id", "latest_preview", "supplier_hash_status", "comparison" ], "title": "SourceState" }, "SourceTarget": { "properties": { "record_id": { "type": "string", "pattern": "^[a-f0-9]{32}$", "title": "Record Id" }, "expected_revision": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Expected Revision" } }, "additionalProperties": false, "type": "object", "required": [ "record_id", "expected_revision" ], "title": "SourceTarget" }, "SourceUnlock": { "properties": { "policy_id": { "type": "string", "maxLength": 100, "minLength": 1, "title": "Policy Id" }, "currency": { "type": "string", "const": "usd", "title": "Currency", "default": "usd" }, "max_amount_minor": { "type": "integer", "maximum": 10000000.0, "minimum": 0.0, "title": "Max Amount Minor" }, "action": { "type": "string", "const": "unlock", "title": "Action" }, "resource": { "type": "string", "enum": [ "people", "companies" ], "title": "Resource" }, "source_id": { "type": "string", "maxLength": 256, "minLength": 1, "pattern": "^[^\\x00-\\x1f\\x7f]+$", "title": "Source Id" } }, "additionalProperties": false, "type": "object", "required": [ "policy_id", "max_amount_minor", "action", "resource", "source_id" ], "title": "SourceUnlock" }, "StartRecovery": { "properties": { "release_available": { "type": "boolean", "title": "Release Available" }, "release": { "anyOf": [ { "$ref": "#/components/schemas/CapacityRelease" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "required": [ "release_available", "release" ], "title": "StartRecovery" }, "StartReview": { "properties": { "id": { "type": "string", "title": "Id" }, "kind": { "type": "string", "const": "start", "title": "Kind" }, "campaign": { "type": "string", "title": "Campaign" }, "campaign_revision": { "type": "integer", "title": "Campaign Revision" }, "capacity": { "$ref": "#/components/schemas/ReviewedCapacity" }, "audience_revision": { "type": "integer", "title": "Audience Revision" }, "remaining_send_count": { "type": "integer", "title": "Remaining Send Count" }, "state": { "type": "string", "const": "reviewed", "title": "State" }, "send_price_cents": { "type": "integer", "title": "Send Price Cents" }, "send_budget_cents": { "type": "integer", "title": "Send Budget Cents" }, "audience_count": { "type": "integer", "title": "Audience Count" }, "sequence_steps": { "type": "integer", "title": "Sequence Steps" }, "send_committed_cents": { "type": "integer", "title": "Send Committed Cents" }, "reviewed_at": { "type": "number", "title": "Reviewed At" }, "reviewed_by": { "type": "string", "title": "Reviewed By" }, "commercial_policy_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Commercial Policy Version" }, "spending_mode": { "anyOf": [ { "type": "string", "enum": [ "finite", "capacity" ] }, { "type": "null" } ], "title": "Spending Mode" }, "schedule": { "anyOf": [ { "$ref": "#/components/schemas/ReviewedSchedule" }, { "type": "null" } ] }, "source_intake": { "anyOf": [ { "$ref": "#/components/schemas/ReviewedSourceIntake" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "required": [ "id", "kind", "campaign", "campaign_revision", "capacity", "audience_revision", "remaining_send_count", "state", "send_price_cents", "send_budget_cents", "audience_count", "sequence_steps", "send_committed_cents", "reviewed_at", "reviewed_by" ], "title": "StartReview" }, "StartReviewIn": { "properties": { "id": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Id" }, "expected_revision": { "type": "integer", "minimum": 1.0, "title": "Expected Revision" }, "spending_mode": { "type": "string", "enum": [ "finite", "capacity" ], "title": "Spending Mode", "default": "finite" }, "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" }, "source_refill": { "anyOf": [ { "$ref": "#/components/schemas/RefillScope" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "required": [ "id", "expected_revision" ], "title": "StartReviewIn" }, "StartReviewPage": { "properties": { "items": { "items": { "$ref": "#/components/schemas/StartReview" }, "type": "array", "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "additionalProperties": false, "type": "object", "required": [ "items", "next_cursor" ], "title": "StartReviewPage" }, "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": { "id": { "type": "integer", "minimum": 0.0, "title": "Id", "description": "Retain the returned ID when editing. Omit only for a new step." }, "subject": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "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": [ "body" ], "title": "Step" }, "StopCapacityReview": { "properties": { "rate_version": { "type": "string", "title": "Rate Version" }, "effective_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Effective At" }, "already_paid_term": { "anyOf": [ { "$ref": "#/components/schemas/PaidCapacityTerm" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "required": [ "rate_version", "effective_at" ], "title": "StopCapacityReview" }, "StopFollowupsIn": { "properties": { "id": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Id" }, "expected_revision": { "type": "integer", "minimum": 1.0, "title": "Expected Revision" } }, "additionalProperties": false, "type": "object", "required": [ "id", "expected_revision" ], "title": "StopFollowupsIn" }, "SubscriptionChange": { "properties": { "id": { "type": "string", "title": "Id" }, "kind": { "type": "string", "enum": [ "initial", "upgrade", "decrease", "cancel", "restore", "renewal" ], "title": "Kind" }, "state": { "type": "string", "enum": [ "reviewed", "submitted", "pending", "completed", "canceled", "blocked" ], "title": "State" }, "invoice": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Invoice" }, "created_at": { "type": "number", "title": "Created At" }, "confirmed_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Confirmed At" }, "error": { "type": "string", "title": "Error" }, "revision": { "type": "integer", "title": "Revision" }, "daily_sends": { "type": "integer", "title": "Daily Sends" }, "reviewed_method": { "anyOf": [ { "$ref": "#/components/schemas/ReviewedCard" }, { "type": "null" } ] }, "maximum_cents": { "type": "integer", "title": "Maximum Cents" }, "credit_cents": { "type": "integer", "title": "Credit Cents" }, "balance_credit_cents": { "type": "integer", "title": "Balance Credit Cents" }, "net_obligation_cents": { "type": "integer", "title": "Net Obligation Cents" }, "term_cents": { "type": "integer", "title": "Term Cents" }, "effective_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Effective At" }, "expires_at": { "type": "integer", "title": "Expires At" }, "policy": { "type": "string", "title": "Policy" }, "cancel_requested": { "type": "boolean", "title": "Cancel Requested" }, "affected_conversations": { "type": "integer", "title": "Affected Conversations" }, "provisioning_policy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provisioning Policy" }, "provisioning": { "anyOf": [ { "$ref": "#/components/schemas/ProvisioningReview" }, { "type": "null" } ] }, "mailbox_plan": { "anyOf": [ { "$ref": "#/components/schemas/MailboxPlan" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "required": [ "id", "kind", "state", "invoice", "created_at", "confirmed_at", "error", "revision", "daily_sends", "reviewed_method", "maximum_cents", "credit_cents", "balance_credit_cents", "net_obligation_cents", "term_cents", "effective_at", "expires_at", "policy", "cancel_requested", "affected_conversations", "provisioning_policy", "provisioning", "mailbox_plan" ], "title": "SubscriptionChange" }, "SubscriptionChangeStatus": { "properties": { "id": { "type": "string", "title": "Id" }, "kind": { "type": "string", "enum": [ "initial", "upgrade", "decrease", "cancel", "restore", "renewal" ], "title": "Kind" }, "state": { "type": "string", "enum": [ "reviewed", "submitted", "pending", "completed", "canceled", "blocked" ], "title": "State" }, "invoice": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Invoice" }, "created_at": { "type": "number", "title": "Created At" }, "confirmed_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Confirmed At" }, "error": { "type": "string", "title": "Error" }, "revision": { "type": "integer", "title": "Revision" }, "daily_sends": { "type": "integer", "title": "Daily Sends" }, "reviewed_method": { "anyOf": [ { "$ref": "#/components/schemas/ReviewedCard" }, { "type": "null" } ] }, "maximum_cents": { "type": "integer", "title": "Maximum Cents" }, "credit_cents": { "type": "integer", "title": "Credit Cents" }, "balance_credit_cents": { "type": "integer", "title": "Balance Credit Cents" }, "net_obligation_cents": { "type": "integer", "title": "Net Obligation Cents" }, "term_cents": { "type": "integer", "title": "Term Cents" }, "effective_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Effective At" }, "expires_at": { "type": "integer", "title": "Expires At" }, "policy": { "type": "string", "title": "Policy" }, "cancel_requested": { "type": "boolean", "title": "Cancel Requested" }, "affected_conversations": { "type": "integer", "title": "Affected Conversations" }, "provisioning_policy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provisioning Policy" }, "provisioning": { "anyOf": [ { "$ref": "#/components/schemas/ProvisioningReview" }, { "type": "null" } ] }, "mailbox_plan": { "anyOf": [ { "$ref": "#/components/schemas/MailboxPlan" }, { "type": "null" } ] }, "provisioning_status": { "anyOf": [ { "$ref": "#/components/schemas/ProvisioningStatus" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "required": [ "id", "kind", "state", "invoice", "created_at", "confirmed_at", "error", "revision", "daily_sends", "reviewed_method", "maximum_cents", "credit_cents", "balance_credit_cents", "net_obligation_cents", "term_cents", "effective_at", "expires_at", "policy", "cancel_requested", "affected_conversations", "provisioning_policy", "provisioning", "mailbox_plan", "provisioning_status" ], "title": "SubscriptionChangeStatus" }, "SubscriptionConfirmation": { "properties": { "enabled": { "type": "boolean", "title": "Enabled" }, "mailbox_recovery": { "$ref": "#/components/schemas/MailboxRecovery" }, "provisioning_available": { "type": "boolean", "title": "Provisioning Available" }, "provisioning_blocker": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provisioning Blocker" }, "payment_mode": { "anyOf": [ { "type": "string", "enum": [ "live", "test" ] }, { "type": "null" } ], "title": "Payment Mode" }, "provisioning_funding_source": { "anyOf": [ { "type": "string", "enum": [ "owner_test", "customer_live" ] }, { "type": "null" } ], "title": "Provisioning Funding Source" }, "observed_at": { "type": "number", "title": "Observed At" }, "policy": { "type": "string", "title": "Policy" }, "pack_sends": { "type": "integer", "title": "Pack Sends" }, "pack_cents": { "type": "integer", "title": "Pack Cents" }, "maximum_sends": { "type": "integer", "title": "Maximum Sends" }, "term_seconds": { "type": "integer", "title": "Term Seconds" }, "currency": { "type": "string", "const": "usd", "title": "Currency" }, "revision": { "type": "integer", "title": "Revision" }, "current": { "anyOf": [ { "$ref": "#/components/schemas/SubscriptionCurrent" }, { "type": "null" } ] }, "changes": { "items": { "$ref": "#/components/schemas/SubscriptionChangeStatus" }, "type": "array", "title": "Changes" }, "invoices": { "items": { "$ref": "#/components/schemas/SubscriptionInvoice" }, "type": "array", "title": "Invoices" }, "changes_next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Changes Next Cursor" }, "invoices_next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Invoices Next Cursor" }, "outcome": { "$ref": "#/components/schemas/SubscriptionOutcome" } }, "additionalProperties": false, "type": "object", "required": [ "enabled", "mailbox_recovery", "provisioning_available", "provisioning_blocker", "payment_mode", "provisioning_funding_source", "observed_at", "policy", "pack_sends", "pack_cents", "maximum_sends", "term_seconds", "currency", "revision", "current", "changes", "invoices", "changes_next_cursor", "invoices_next_cursor", "outcome" ], "title": "SubscriptionConfirmation" }, "SubscriptionCurrent": { "properties": { "paid_quantity": { "type": "integer", "title": "Paid Quantity" }, "period_start": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Period Start" }, "period_end": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Period End" }, "next_quantity": { "type": "integer", "title": "Next Quantity" }, "cancel_at_end": { "type": "integer", "enum": [ 0, 1 ], "title": "Cancel At End" }, "paid_invoice": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Paid Invoice" }, "observed_at": { "type": "number", "title": "Observed At" }, "review_required": { "type": "string", "title": "Review Required" }, "error": { "type": "string", "title": "Error" } }, "additionalProperties": false, "type": "object", "required": [ "paid_quantity", "period_start", "period_end", "next_quantity", "cancel_at_end", "paid_invoice", "observed_at", "review_required", "error" ], "title": "SubscriptionCurrent" }, "SubscriptionInvoice": { "properties": { "invoice": { "type": "string", "title": "Invoice" }, "quantity": { "type": "integer", "title": "Quantity" }, "period_start": { "type": "integer", "title": "Period Start" }, "period_end": { "type": "integer", "title": "Period End" }, "amount_cents": { "type": "integer", "title": "Amount Cents" }, "credit_cents": { "type": "integer", "title": "Credit Cents" }, "fulfillment": { "type": "string", "enum": [ "pending", "applied", "review" ], "title": "Fulfillment" }, "review_required": { "type": "string", "title": "Review Required" }, "payment_review": { "type": "string", "title": "Payment Review" }, "card_cents": { "type": "integer", "title": "Card Cents" }, "balance_credit_cents": { "type": "integer", "title": "Balance Credit Cents" }, "service_decision": { "anyOf": [ { "type": "string", "enum": [ "retain_original_service", "withhold_service" ] }, { "type": "null" } ], "title": "Service Decision" }, "refunded_cents": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Refunded Cents" } }, "additionalProperties": false, "type": "object", "required": [ "invoice", "quantity", "period_start", "period_end", "amount_cents", "credit_cents", "fulfillment", "review_required", "payment_review", "card_cents", "balance_credit_cents", "service_decision", "refunded_cents" ], "title": "SubscriptionInvoice" }, "SubscriptionOutcome": { "properties": { "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "funded": { "type": "boolean", "title": "Funded" }, "fulfillment": { "type": "string", "enum": [ "pending", "applied", "review" ], "title": "Fulfillment" }, "error": { "type": "string", "title": "Error" }, "provisioning": { "type": "boolean", "title": "Provisioning" } }, "additionalProperties": false, "type": "object", "title": "SubscriptionOutcome" }, "SubscriptionRecovery": { "properties": { "invoice": { "type": "string", "title": "Invoice" }, "url": { "type": "string", "title": "Url" }, "amount_cents": { "type": "integer", "title": "Amount Cents" }, "period_start": { "type": "integer", "title": "Period Start" }, "period_end": { "type": "integer", "title": "Period End" } }, "additionalProperties": false, "type": "object", "required": [ "invoice", "url", "amount_cents", "period_start", "period_end" ], "title": "SubscriptionRecovery" }, "SubscriptionSnapshot": { "properties": { "enabled": { "type": "boolean", "title": "Enabled" }, "mailbox_recovery": { "$ref": "#/components/schemas/MailboxRecovery" }, "provisioning_available": { "type": "boolean", "title": "Provisioning Available" }, "provisioning_blocker": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provisioning Blocker" }, "payment_mode": { "anyOf": [ { "type": "string", "enum": [ "live", "test" ] }, { "type": "null" } ], "title": "Payment Mode" }, "provisioning_funding_source": { "anyOf": [ { "type": "string", "enum": [ "owner_test", "customer_live" ] }, { "type": "null" } ], "title": "Provisioning Funding Source" }, "observed_at": { "type": "number", "title": "Observed At" }, "policy": { "type": "string", "title": "Policy" }, "pack_sends": { "type": "integer", "title": "Pack Sends" }, "pack_cents": { "type": "integer", "title": "Pack Cents" }, "maximum_sends": { "type": "integer", "title": "Maximum Sends" }, "term_seconds": { "type": "integer", "title": "Term Seconds" }, "currency": { "type": "string", "const": "usd", "title": "Currency" }, "revision": { "type": "integer", "title": "Revision" }, "current": { "anyOf": [ { "$ref": "#/components/schemas/SubscriptionCurrent" }, { "type": "null" } ] }, "changes": { "items": { "$ref": "#/components/schemas/SubscriptionChangeStatus" }, "type": "array", "title": "Changes" }, "invoices": { "items": { "$ref": "#/components/schemas/SubscriptionInvoice" }, "type": "array", "title": "Invoices" }, "changes_next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Changes Next Cursor" }, "invoices_next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Invoices Next Cursor" } }, "additionalProperties": false, "type": "object", "required": [ "enabled", "mailbox_recovery", "provisioning_available", "provisioning_blocker", "payment_mode", "provisioning_funding_source", "observed_at", "policy", "pack_sends", "pack_cents", "maximum_sends", "term_seconds", "currency", "revision", "current", "changes", "invoices", "changes_next_cursor", "invoices_next_cursor" ], "title": "SubscriptionSnapshot" }, "SuppressionDefaults": { "properties": { "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": [ "reason", "evidence" ], "title": "SuppressionDefaults" }, "SuppressionExport": { "properties": { "scope": { "type": "string", "enum": [ "email", "domain" ], "title": "Scope" }, "max_bytes": { "type": "integer", "maximum": 4294967296.0, "minimum": 1.0, "title": "Max Bytes", "default": 67108864 } }, "additionalProperties": false, "type": "object", "required": [ "scope" ], "title": "SuppressionExport" }, "UnavailableInboundMessage": { "properties": { "seq": { "type": "integer", "title": "Seq" }, "direction": { "type": "string", "enum": [ "in", "out" ], "title": "Direction" }, "authorship": { "type": "string", "enum": [ "external", "campaign", "human", "automation" ], "title": "Authorship" }, "occurred_at": { "type": "number", "title": "Occurred At" }, "event_id": { "type": "string", "title": "Event Id" }, "content": { "type": "null", "title": "Content" }, "kind": { "type": "string", "const": "unavailable", "title": "Kind" }, "classification": { "anyOf": [ { "$ref": "#/components/schemas/ReplyClassificationObservation" }, { "$ref": "#/components/schemas/AgentClassificationObservation" } ], "title": "Classification" }, "participants": { "anyOf": [ { "$ref": "#/components/schemas/MessageParticipants" }, { "type": "null" } ] }, "subject": { "type": "string", "title": "Subject" }, "attachments": { "items": { "$ref": "#/components/schemas/MessageAttachment" }, "type": "array", "title": "Attachments" }, "attachments_state": { "type": "string", "enum": [ "available", "none", "unavailable", "original_only" ], "title": "Attachments State" } }, "additionalProperties": false, "type": "object", "required": [ "seq", "direction", "authorship", "occurred_at", "event_id", "content", "kind", "participants" ], "title": "UnavailableInboundMessage" }, "UnavailableOutboundMessage": { "properties": { "seq": { "type": "integer", "title": "Seq" }, "direction": { "type": "string", "enum": [ "in", "out" ], "title": "Direction" }, "authorship": { "type": "string", "enum": [ "external", "campaign", "human", "automation" ], "title": "Authorship" }, "occurred_at": { "type": "number", "title": "Occurred At" }, "content": { "type": "null", "title": "Content" }, "state": { "type": "string", "const": "unavailable", "title": "State" } }, "additionalProperties": false, "type": "object", "required": [ "seq", "direction", "authorship", "occurred_at", "content", "state" ], "title": "UnavailableOutboundMessage" }, "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" }, "VerificationBatchView": { "properties": { "id": { "type": "string", "title": "Id" }, "campaign": { "type": "string", "title": "Campaign" }, "revision": { "type": "integer", "title": "Revision" }, "policy": { "type": "string", "title": "Policy" }, "rate_version": { "type": "string", "title": "Rate Version" }, "price_cents": { "type": "integer", "title": "Price Cents" }, "maximum_cents": { "type": "integer", "title": "Maximum Cents" }, "authorized_cents": { "type": "integer", "title": "Authorized Cents" }, "mode": { "type": "string", "enum": [ "manual", "automatic" ], "title": "Mode" }, "target_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Target Count" }, "completed_count": { "type": "integer", "title": "Completed Count" }, "state": { "type": "string", "enum": [ "active", "complete", "blocked", "cancelled" ], "title": "State" }, "error": { "type": "string", "title": "Error" }, "created_at": { "type": "number", "title": "Created At" }, "deadline": { "type": "number", "title": "Deadline" } }, "additionalProperties": false, "type": "object", "required": [ "id", "campaign", "revision", "policy", "rate_version", "price_cents", "maximum_cents", "authorized_cents", "mode", "target_count", "completed_count", "state", "error", "created_at", "deadline" ], "title": "VerificationBatchView" }, "VerificationCohort": { "properties": { "verdict": { "type": "string", "enum": [ "valid", "invalid", "catch_all", "risky", "unknown", "unverified" ], "title": "Verdict" }, "accepted_enrollments": { "type": "integer", "minimum": 0.0, "title": "Accepted Enrollments" }, "human_replied_enrollments": { "type": "integer", "minimum": 0.0, "title": "Human Replied Enrollments" }, "unclassified_replied_enrollments": { "type": "integer", "minimum": 0.0, "title": "Unclassified Replied Enrollments" }, "human_reply_rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Human Reply Rate" } }, "additionalProperties": false, "type": "object", "required": [ "verdict", "accepted_enrollments", "human_replied_enrollments", "unclassified_replied_enrollments", "human_reply_rate" ], "title": "VerificationCohort" }, "VerificationCohorts": { "properties": { "cohort_start": { "type": "number", "title": "Cohort Start" }, "cohort_end": { "type": "number", "title": "Cohort End" }, "observed_at": { "type": "number", "title": "Observed At" }, "items": { "items": { "$ref": "#/components/schemas/VerificationCohort" }, "type": "array", "maxItems": 6, "title": "Items" }, "definition": { "type": "string", "title": "Definition" } }, "additionalProperties": false, "type": "object", "required": [ "cohort_start", "cohort_end", "observed_at", "items", "definition" ], "title": "VerificationCohorts" }, "VerificationUsageGroup": { "properties": { "day": { "type": "string", "title": "Day" }, "campaign": { "type": "string", "title": "Campaign" }, "campaign_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Campaign Name" }, "rate_version": { "type": "string", "title": "Rate Version" }, "posted_count": { "type": "integer", "title": "Posted Count" }, "posted_cents": { "type": "integer", "title": "Posted Cents" } }, "type": "object", "required": [ "day", "campaign", "rate_version", "posted_count", "posted_cents" ], "title": "VerificationUsageGroup" }, "VerificationUsagePage": { "properties": { "items": { "items": { "$ref": "#/components/schemas/VerificationUsageGroup" }, "type": "array", "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "totals": { "$ref": "#/components/schemas/VerificationUsageTotals" }, "pending": { "$ref": "#/components/schemas/VerificationUsagePending" }, "start": { "type": "number", "title": "Start" }, "end": { "type": "number", "title": "End" }, "campaign": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Campaign" }, "currency": { "type": "string", "const": "USD", "title": "Currency" }, "amount_unit": { "type": "string", "const": "cents", "title": "Amount Unit" }, "observed_at": { "type": "number", "title": "Observed At" }, "semantics": { "type": "string", "const": "posted_verification_events_not_holds_or_reused_evidence", "title": "Semantics" }, "day_clock": { "type": "string", "const": "UTC", "title": "Day Clock" } }, "type": "object", "required": [ "items", "next_cursor", "totals", "pending", "start", "end", "campaign", "currency", "amount_unit", "observed_at", "semantics", "day_clock" ], "title": "VerificationUsagePage" }, "VerificationUsagePending": { "properties": { "held_count": { "type": "integer", "title": "Held Count" }, "held_cents": { "type": "integer", "title": "Held Cents" }, "unknown_count": { "type": "integer", "title": "Unknown Count" } }, "type": "object", "required": [ "held_count", "held_cents", "unknown_count" ], "title": "VerificationUsagePending" }, "VerificationUsageTotals": { "properties": { "posted_count": { "type": "integer", "title": "Posted Count" }, "posted_cents": { "type": "integer", "title": "Posted Cents" }, "unattributed_cents": { "type": "integer", "title": "Unattributed Cents" } }, "type": "object", "required": [ "posted_count", "posted_cents", "unattributed_cents" ], "title": "VerificationUsageTotals" }, "VerificationView": { "properties": { "required": { "type": "boolean", "title": "Required" }, "state": { "type": "string", "title": "State" }, "verdict": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Verdict" }, "checked_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Checked At" }, "expires_at": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Expires At" }, "dispatch_verdict": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dispatch Verdict" }, "dispatch_policy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dispatch Policy" } }, "type": "object", "required": [ "required", "state" ], "title": "VerificationView" }, "WalletUsage": { "properties": { "balance_cents": { "type": "integer", "title": "Balance Cents" }, "debt_cents": { "type": "integer", "title": "Debt Cents" }, "state": { "type": "string", "title": "State" }, "held_cents": { "type": "integer", "title": "Held Cents" }, "spendable_cents": { "type": "integer", "title": "Spendable Cents" }, "entries": { "items": { "$ref": "#/components/schemas/LedgerEntry" }, "type": "array", "title": "Entries" } }, "additionalProperties": false, "type": "object", "required": [ "balance_cents", "debt_cents", "state", "held_cents", "spendable_cents", "entries" ], "title": "WalletUsage" }, "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" }, "WindowActivity": { "properties": { "elapsed_seconds": { "type": "number", "title": "Elapsed Seconds" }, "active_seconds": { "type": "number", "title": "Active Seconds" }, "inactive_seconds": { "type": "number", "title": "Inactive Seconds" }, "unknown_seconds": { "type": "number", "title": "Unknown Seconds" }, "state": { "type": "string", "enum": [ "not_started", "unavailable", "unknown", "active", "partial", "inactive" ], "title": "State" }, "reason": { "type": "string", "title": "Reason", "description": "Present only when activity is unavailable." } }, "additionalProperties": false, "type": "object", "required": [ "elapsed_seconds", "active_seconds", "inactive_seconds", "unknown_seconds", "state" ], "title": "WindowActivity" }, "WindowAttempts": { "properties": { "reserved": { "type": "integer", "title": "Reserved" }, "dispatch_recorded": { "type": "integer", "title": "Dispatch Recorded" }, "accepted": { "type": "integer", "title": "Accepted" }, "not_accepted": { "type": "integer", "title": "Not Accepted" }, "unknown": { "type": "integer", "title": "Unknown" }, "in_progress": { "type": "integer", "title": "In Progress" }, "requeued": { "type": "integer", "title": "Requeued" }, "accepted_timing_unproven": { "type": "integer", "title": "Accepted Timing Unproven" }, "dispatch_outside_window": { "type": "integer", "title": "Dispatch Outside Window" } }, "additionalProperties": false, "type": "object", "required": [ "reserved", "dispatch_recorded", "accepted", "not_accepted", "unknown", "in_progress", "requeued", "accepted_timing_unproven", "dispatch_outside_window" ], "title": "WindowAttempts" }, "WindowBlocker": { "properties": { "reason": { "type": "string", "title": "Reason" }, "category": { "type": "string", "title": "Category" }, "observed_samples": { "type": "integer", "title": "Observed Samples" }, "first_observed_at": { "type": "number", "title": "First Observed At" }, "last_observed_at": { "type": "number", "title": "Last Observed At" } }, "additionalProperties": false, "type": "object", "required": [ "reason", "category", "observed_samples", "first_observed_at", "last_observed_at" ], "title": "WindowBlocker" }, "WindowPressure": { "properties": { "local_date": { "type": "string", "title": "Local Date" }, "opens_at": { "type": "number", "title": "Opens At" }, "closes_at": { "type": "number", "title": "Closes At" }, "eligible_by_close": { "type": "integer", "title": "Eligible By Close" }, "nominal_gap_seconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Nominal Gap Seconds" }, "pacing_slots_upper_bound": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Pacing Slots Upper Bound" }, "carryover_lower_bound": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Carryover Lower Bound" } }, "type": "object", "required": [ "local_date", "opens_at", "closes_at", "eligible_by_close", "nominal_gap_seconds", "pacing_slots_upper_bound", "carryover_lower_bound" ], "title": "WindowPressure" }, "WorkExperience": { "properties": { "COMPANY_NAME": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company Name" }, "POSITION": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Position" }, "COMPANY_IDENTIFIER": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company Identifier" }, "COMPANY_LINKEDIN_UID": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company Linkedin Uid" }, "COMPANY_LINKEDIN_URL": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Company Linkedin Url" }, "START_DATE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Start Date" }, "END_DATE": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "End Date" } }, "additionalProperties": false, "type": "object", "title": "WorkExperience" }, "WorkspaceMember": { "properties": { "id": { "type": "string", "title": "Id" }, "email": { "type": "string", "title": "Email" }, "role": { "type": "string", "enum": [ "owner", "operator", "member" ], "title": "Role" }, "revision": { "type": "string", "title": "Revision" } }, "additionalProperties": false, "type": "object", "required": [ "id", "email", "role", "revision" ], "title": "WorkspaceMember" }, "WorkspaceMembers": { "properties": { "items": { "items": { "$ref": "#/components/schemas/WorkspaceMember" }, "type": "array", "maxItems": 200, "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "additionalProperties": false, "type": "object", "required": [ "items", "next_cursor" ], "title": "WorkspaceMembers" }, "sequencer__application__draft_operations__Counts": { "properties": { "contacts": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Contacts" }, "added": { "type": "integer", "minimum": 0.0, "title": "Added" }, "excluded": { "type": "integer", "minimum": 0.0, "title": "Excluded" } }, "additionalProperties": false, "type": "object", "required": [ "contacts", "added", "excluded" ], "title": "Counts" }, "sequencer__application__name_cleaning_api__Counts": { "properties": { "unchecked": { "type": "integer", "minimum": 0.0, "title": "Unchecked" }, "ready": { "type": "integer", "minimum": 0.0, "title": "Ready" }, "pending": { "type": "integer", "minimum": 0.0, "title": "Pending" }, "held": { "type": "integer", "minimum": 0.0, "title": "Held" }, "unavailable": { "type": "integer", "minimum": 0.0, "title": "Unavailable" } }, "type": "object", "required": [ "unchecked", "ready", "pending", "held", "unavailable" ], "title": "Counts" }, "sequencer__application__send_projection__Counts": { "properties": { "first_touches": { "type": "integer", "title": "First Touches", "default": 0 }, "followups": { "type": "integer", "title": "Followups", "default": 0 } }, "additionalProperties": false, "type": "object", "title": "Counts" } } } }