{ "components": { "schemas": { "AiField": { "additionalProperties": true, "description": "A per-lead variable a model writes before each message, e.g. {recent_post}.", "properties": { "ai_instructions": { "title": "Ai Instructions", "type": "string" }, "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Created At" }, "data_sources": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Data Sources" }, "fallback_value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Fallback Value" }, "field_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Field Description" }, "field_name": { "title": "Field Name", "type": "string" }, "id": { "title": "Id", "type": "string" }, "is_active": { "default": true, "title": "Is Active", "type": "boolean" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated At" } }, "required": [ "id", "field_name", "ai_instructions" ], "title": "AiField", "type": "object" }, "AnalysisChannels": { "additionalProperties": true, "properties": { "email": { "anyOf": [ { "$ref": "#/components/schemas/AnalysisEmailChannel" }, { "type": "null" } ], "default": null }, "linkedin": { "anyOf": [ { "$ref": "#/components/schemas/AnalysisLinkedInChannel" }, { "type": "null" } ], "default": null } }, "title": "AnalysisChannels", "type": "object" }, "AnalysisEmailChannel": { "additionalProperties": true, "properties": { "open_rate_pct": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Open Rate Pct" }, "opened": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Opened" }, "positive_leads": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Positive Leads" }, "replied_leads": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Replied Leads" }, "sent": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Sent" } }, "title": "AnalysisEmailChannel", "type": "object" }, "AnalysisFunnel": { "additionalProperties": true, "properties": { "contacted": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Contacted" }, "enrolled": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Enrolled" }, "meeting_rate_pct": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "meetings / positive; null when there were no positives", "title": "Meeting Rate Pct" }, "meetings": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Meetings" }, "positive": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Positive" }, "positive_rate_pct": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "positive / contacted; null when nobody was contacted", "title": "Positive Rate Pct" }, "replied": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Replied" }, "reply_rate_pct": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "replied / contacted; null when nobody was contacted", "title": "Reply Rate Pct" } }, "title": "AnalysisFunnel", "type": "object" }, "AnalysisLeads": { "additionalProperties": true, "properties": { "active": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Active" }, "completed": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Completed" }, "enrolled": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Enrolled" }, "not_contacted": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Not Contacted" }, "paused": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Paused" } }, "title": "AnalysisLeads", "type": "object" }, "AnalysisLinkedInChannel": { "additionalProperties": true, "properties": { "accept_rate_pct": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Accept Rate Pct" }, "accepted": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Accepted" }, "connected_leads": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Connected Leads" }, "messages": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Messages" }, "positive_leads": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Positive Leads" }, "replied_leads": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Replied Leads" }, "requests": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Connection requests sent", "title": "Requests" } }, "title": "AnalysisLinkedInChannel", "type": "object" }, "AnalysisReplies": { "additionalProperties": true, "properties": { "negative": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Negative" }, "neutral": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Neutral" }, "ooo": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Out-of-office replies", "title": "Ooo" }, "positive": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Positive" }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Total" } }, "title": "AnalysisReplies", "type": "object" }, "AnalysisVariation": { "additionalProperties": true, "properties": { "contacted": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Contacted" }, "enrolled": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Enrolled" }, "meetings": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Meetings" }, "positive": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Positive" }, "replied": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Replied" } }, "title": "AnalysisVariation", "type": "object" }, "AnalysisWindow": { "additionalProperties": true, "properties": { "from": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "Start of the window; null = all time", "title": "From" }, "to": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "End of the window; null = now", "title": "To" }, "variation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The A/B arm the report covers: 'a', 'b', 'unassigned', or 'all'", "enum": [ "a", "b", "unassigned", "all", null ], "title": "Variation" } }, "title": "AnalysisWindow", "type": "object" }, "Campaign": { "description": "A campaign as listed by GET /campaigns. The exact columns the list\nselects -- the id was previously passed through undeclared and so was\nmissing from the published document.", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Campaign description", "examples": [ "Targeting enterprise accounts in the tech sector" ], "title": "Description" }, "id": { "description": "Campaign UUID", "examples": [ "550e8400-e29b-41d4-a716-446655440000" ], "title": "Id", "type": "string" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the campaign is currently active", "examples": [ true ], "title": "Is Active" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Campaign name", "examples": [ "Q1 Enterprise Outreach" ], "title": "Name" }, "organization_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Organization ID that owns this campaign", "examples": [ "123e4567-e89b-12d3-a456-426614174000" ], "title": "Organization Id" }, "refill_policy": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Automatic lead-refill policy ({enabled, min_backlog, max_add_per_run, ...}); null = report only", "title": "Refill Policy" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User ID that created this campaign", "examples": [ "987fcdeb-51a2-4d4e-b567-890123456789" ], "title": "User Id" } }, "required": [ "id" ], "title": "Campaign", "type": "object" }, "CampaignAnalysis": { "additionalProperties": true, "description": "Aggregate analytics for one campaign, counted by each lead's *first*\nevent of a kind inside the window.", "properties": { "by_variation": { "anyOf": [ { "additionalProperties": { "$ref": "#/components/schemas/AnalysisVariation" }, "type": "object" }, { "type": "null" } ], "default": null, "description": "Per-arm breakdown keyed by A/B arm: 'a', 'b', 'unassigned' (leads with no arm yet)", "title": "By Variation" }, "channels": { "anyOf": [ { "$ref": "#/components/schemas/AnalysisChannels" }, { "type": "null" } ], "default": null }, "funnel": { "anyOf": [ { "$ref": "#/components/schemas/AnalysisFunnel" }, { "type": "null" } ], "default": null }, "leads": { "anyOf": [ { "$ref": "#/components/schemas/AnalysisLeads" }, { "type": "null" } ], "default": null }, "replies": { "anyOf": [ { "$ref": "#/components/schemas/AnalysisReplies" }, { "type": "null" } ], "default": null }, "window": { "anyOf": [ { "$ref": "#/components/schemas/AnalysisWindow" }, { "type": "null" } ], "default": null } }, "title": "CampaignAnalysis", "type": "object" }, "CampaignDetail": { "description": "Full campaign details returned from the database.", "properties": { "ab_testing_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether A/B testing is enabled for message variations", "examples": [ true ], "title": "Ab Testing Enabled" }, "created_at": { "description": "When the campaign was created", "examples": [ "2024-01-15T10:30:00Z" ], "format": "date-time", "title": "Created At", "type": "string" }, "custom_fields": { "anyOf": [ {}, { "type": "null" } ], "default": null, "description": "Custom fields \u2014 object on newer campaigns, list on legacy ones", "title": "Custom Fields" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Campaign description", "examples": [ "Targeting enterprise accounts in the tech sector" ], "title": "Description" }, "enabled_accounts": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of connected account IDs used for outreach", "title": "Enabled Accounts" }, "id": { "description": "Campaign UUID", "examples": [ "550e8400-e29b-41d4-a716-446655440000" ], "title": "Id", "type": "string" }, "is_active": { "description": "Whether the campaign is currently active", "examples": [ true ], "title": "Is Active", "type": "boolean" }, "lead_database_filters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Lead-database search filters defining this campaign's ICP (same shape the lead database search accepts)", "title": "Lead Database Filters" }, "name": { "description": "Campaign name", "examples": [ "Q1 Enterprise Outreach" ], "title": "Name", "type": "string" }, "refill_policy": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Automatic lead-refill policy: {enabled, min_backlog, target_backlog, max_add_per_run, max_tokens_per_run, cooldown_hours, mode}", "title": "Refill Policy" }, "responder_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether AI auto-responder is enabled", "examples": [ true ], "title": "Responder Enabled" }, "sequence": { "anyOf": [ {}, { "type": "null" } ], "default": null, "description": "Campaign sequence: an object with variation_a and variation_b message templates, or an empty list on a campaign with no sequence yet", "title": "Sequence" }, "traffic_split": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Traffic split percentage for A/B testing (0-100)", "examples": [ 50 ], "title": "Traffic Split" }, "updated_at": { "description": "When the campaign was last updated", "examples": [ "2024-01-20T14:45:00Z" ], "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "name", "is_active", "created_at", "updated_at" ], "title": "CampaignDetail", "type": "object" }, "CampaignQueue": { "description": "Queue depth and runway for a campaign: how many leads are waiting, in\nprogress or done, and how far today's send capacity goes.", "properties": { "active_senders": { "default": 0, "title": "Active Senders", "type": "integer" }, "backlog": { "default": 0, "description": "Sequence leads not yet started (is_active=false, completed=false)", "title": "Backlog", "type": "integer" }, "capacity_source": { "default": "none", "enum": [ "campaign", "org", "none" ], "title": "Capacity Source", "type": "string" }, "completed": { "default": 0, "title": "Completed", "type": "integer" }, "daily_capacity": { "default": 0, "description": "Sum of first-touch daily limits (connection_request + email)", "title": "Daily Capacity", "type": "integer" }, "days_of_runway": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "backlog / daily_capacity; null when capacity or senders are zero", "title": "Days Of Runway" }, "enabled_accounts": { "items": { "type": "string" }, "title": "Enabled Accounts", "type": "array" }, "has_filters": { "default": false, "description": "Whether lead_database_filters is set (required for auto-refill)", "title": "Has Filters", "type": "boolean" }, "in_progress": { "default": 0, "description": "Sequence leads mid-sequence", "title": "In Progress", "type": "integer" }, "is_active": { "default": false, "title": "Is Active", "type": "boolean" }, "last_refill": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "The most recent lead-refill job for the campaign (status, counts, timestamps), or null if none has run", "title": "Last Refill" }, "limits": { "additionalProperties": true, "description": "Per-platform {daily_limit, current_usage, reset_date}", "title": "Limits", "type": "object" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "refill_policy": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Refill Policy" }, "total": { "default": 0, "title": "Total", "type": "integer" }, "warnings": { "items": { "type": "string" }, "title": "Warnings", "type": "array" } }, "title": "CampaignQueue", "type": "object" }, "ConnectedAccount": { "additionalProperties": true, "description": "A connected sender account.", "properties": { "account_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Unipile account id", "title": "Account Id" }, "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Created At" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Email" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "false = disconnected, needs reconnect", "title": "Is Active" }, "organization_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Organization Id" }, "platform": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "linkedin | email", "title": "Platform" }, "platform_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Platform Username" }, "system_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "System Id" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "User Id" } }, "title": "ConnectedAccount", "type": "object" }, "CreateDealLeadData": { "description": "Inline lead data for creating a lead alongside a deal.", "properties": { "annual_revenue": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Company annual revenue in dollars", "examples": [ 5000000 ], "title": "Annual Revenue" }, "company": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Company name", "examples": [ "Acme Corp" ], "title": "Company" }, "company_website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Company website URL", "examples": [ "https://acmecorp.com" ], "title": "Company Website" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Lead's email address (required if linkedin_url not provided)", "examples": [ "sarah.johnson@acmecorp.com" ], "title": "Email" }, "employees": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of employees", "examples": [ 150 ], "title": "Employees" }, "first_name": { "description": "Lead's first name", "examples": [ "Sarah" ], "title": "First Name", "type": "string" }, "industry": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Industry sector", "examples": [ "Technology" ], "title": "Industry" }, "last_name": { "description": "Lead's last name", "examples": [ "Johnson" ], "title": "Last Name", "type": "string" }, "linkedin_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Lead's LinkedIn profile URL (required if email not provided)", "examples": [ "https://linkedin.com/in/sarahjohnson" ], "title": "Linkedin Url" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Job title", "examples": [ "VP of Sales" ], "title": "Title" } }, "required": [ "first_name", "last_name" ], "title": "CreateDealLeadData", "type": "object" }, "DailyStatsDay": { "additionalProperties": true, "properties": { "day": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "YYYY-MM-DD, UTC", "title": "Day" }, "emails_opened": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Emails Opened" }, "emails_sent": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Emails Sent" }, "leads_first_contacted": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Leads whose first touch was that day", "title": "Leads First Contacted" }, "leads_first_positive": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Leads whose first positive reply came that day", "title": "Leads First Positive" }, "leads_first_replied": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Leads whose first reply came that day", "title": "Leads First Replied" }, "li_connection_requests": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "LinkedIn connection requests sent", "title": "Li Connection Requests" }, "li_connections_accepted": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "LinkedIn connection requests accepted", "title": "Li Connections Accepted" }, "li_messages": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "LinkedIn messages sent", "title": "Li Messages" }, "meetings_booked": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Meetings Booked" }, "partial": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "True for today: the rollup is refreshed hourly, so today's row is still filling in", "title": "Partial" }, "platform": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Only when group_by=sender: 'email' or 'linkedin'", "title": "Platform" }, "replies_negative": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Replies Negative" }, "replies_neutral": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Replies Neutral" }, "replies_ooo": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Out-of-office replies", "title": "Replies Ooo" }, "replies_positive": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Replies Positive" }, "sender_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Only when group_by=sender", "title": "Sender Key" }, "variation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Only when group_by=variation: the A/B arm, or null for leads with none", "title": "Variation" } }, "title": "DailyStatsDay", "type": "object" }, "DailyStatsWindow": { "properties": { "from": { "description": "First day covered, YYYY-MM-DD", "title": "From", "type": "string" }, "timezone": { "default": "UTC", "description": "Days are UTC calendar days", "title": "Timezone", "type": "string" }, "to": { "description": "Last day covered, YYYY-MM-DD", "title": "To", "type": "string" } }, "required": [ "from", "to" ], "title": "DailyStatsWindow", "type": "object" }, "Deal": { "description": "Sales opportunity (deal) data model.", "properties": { "actual_close_date": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "Actual close date (set when deal is won/lost)", "title": "Actual Close Date" }, "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "When the deal was created", "examples": [ "2024-01-15T10:30:00Z" ], "title": "Created At" }, "custom_fields": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Custom fields as key-value pairs", "title": "Custom Fields" }, "expected_close_date": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "Expected close date", "examples": [ "2024-03-31T00:00:00Z" ], "title": "Expected Close Date" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Deal ID", "examples": [ "e3f4a5b6-c7d8-9012-ef01-345678901234" ], "title": "Id" }, "lead_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Associated lead ID", "examples": [ "a1b2c3d4-e5f6-7890-abcd-ef1234567890" ], "title": "Lead Id" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional metadata", "title": "Metadata" }, "name": { "description": "Deal name/title", "examples": [ "Acme Corp - Enterprise License" ], "title": "Name", "type": "string" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Deal notes", "examples": [ "Initial meeting scheduled for next week" ], "title": "Notes" }, "owner_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ID of the deal owner (user)", "examples": [ "f4a5b6c7-d8e9-0123-f012-456789012345" ], "title": "Owner Id" }, "probability": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Win probability percentage (0-100)", "examples": [ 75 ], "title": "Probability" }, "stage_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Current stage ID", "examples": [ "d2e3f4a5-b6c7-8901-def0-234567890123" ], "title": "Stage Id" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "When the deal was last updated", "examples": [ "2024-01-20T14:45:00Z" ], "title": "Updated At" }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Deal value in dollars", "examples": [ 50000.0 ], "title": "Value" } }, "required": [ "name" ], "title": "Deal", "type": "object" }, "DealWithLead": { "description": "Deal with expanded lead information.", "properties": { "actual_close_date": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "Actual close date (set when deal is won/lost)", "title": "Actual Close Date" }, "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "When the deal was created", "examples": [ "2024-01-15T10:30:00Z" ], "title": "Created At" }, "custom_fields": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Custom fields as key-value pairs", "title": "Custom Fields" }, "expected_close_date": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "Expected close date", "examples": [ "2024-03-31T00:00:00Z" ], "title": "Expected Close Date" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Deal ID", "examples": [ "e3f4a5b6-c7d8-9012-ef01-345678901234" ], "title": "Id" }, "lead": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Associated lead data", "title": "Lead" }, "lead_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Associated lead ID", "examples": [ "a1b2c3d4-e5f6-7890-abcd-ef1234567890" ], "title": "Lead Id" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional metadata", "title": "Metadata" }, "name": { "description": "Deal name/title", "examples": [ "Acme Corp - Enterprise License" ], "title": "Name", "type": "string" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Deal notes", "examples": [ "Initial meeting scheduled for next week" ], "title": "Notes" }, "owner_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ID of the deal owner (user)", "examples": [ "f4a5b6c7-d8e9-0123-f012-456789012345" ], "title": "Owner Id" }, "probability": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Win probability percentage (0-100)", "examples": [ 75 ], "title": "Probability" }, "stage_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Current stage ID", "examples": [ "d2e3f4a5-b6c7-8901-def0-234567890123" ], "title": "Stage Id" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "When the deal was last updated", "examples": [ "2024-01-20T14:45:00Z" ], "title": "Updated At" }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Deal value in dollars", "examples": [ 50000.0 ], "title": "Value" } }, "required": [ "name" ], "title": "DealWithLead", "type": "object" }, "Enrollment": { "description": "A lead's membership in a campaign, when one was requested.", "properties": { "campaign_id": { "description": "Campaign the lead was enrolled in", "examples": [ "550e8400-e29b-41d4-a716-446655440000" ], "title": "Campaign Id", "type": "string" }, "sequence_lead_id": { "description": "ID of the campaign sequence entry", "examples": [ "b2c3d4e5-f6a7-8901-bcde-f12345678901" ], "title": "Sequence Lead Id", "type": "string" } }, "required": [ "sequence_lead_id", "campaign_id" ], "title": "Enrollment", "type": "object" }, "Lead": { "description": "Lead data model with required and optional fields.\n\nRequired: first_name, last_name, and at least one of email OR linkedin_url.", "properties": { "annual_revenue": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Company annual revenue in dollars", "examples": [ 5000000 ], "title": "Annual Revenue" }, "company": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Company name", "examples": [ "Acme Corp" ], "title": "Company" }, "company_website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Lead's company website URL", "examples": [ "https://acmecorp.com" ], "title": "Company Website" }, "custom_fields": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Custom fields as key-value pairs", "examples": [ { "priority": "high", "source": "conference" } ], "title": "Custom Fields" }, "email": { "anyOf": [ { "format": "email", "type": "string" }, { "type": "null" } ], "default": null, "description": "Lead's email address (required if linkedin_url not provided)", "examples": [ "sarah.johnson@acmecorp.com" ], "title": "Email" }, "employees": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of employees at the company", "examples": [ 150 ], "title": "Employees" }, "first_name": { "description": "Lead's first name", "examples": [ "Sarah" ], "title": "First Name", "type": "string" }, "industry": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Industry sector", "examples": [ "Technology" ], "title": "Industry" }, "last_name": { "description": "Lead's last name", "examples": [ "Johnson" ], "title": "Last Name", "type": "string" }, "linkedin_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Lead's LinkedIn profile URL (required if email not provided)", "examples": [ "https://linkedin.com/in/sarahjohnson" ], "title": "Linkedin Url" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Job title", "examples": [ "VP of Sales" ], "title": "Title" } }, "required": [ "first_name", "last_name" ], "title": "Lead", "type": "object" }, "LeadDetail": { "description": "Full lead details returned from the database.", "properties": { "annual_revenue": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Company annual revenue in dollars", "examples": [ 5000000 ], "title": "Annual Revenue" }, "company": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Company name", "examples": [ "Acme Corp" ], "title": "Company" }, "company_website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Lead's company website URL", "examples": [ "https://acmecorp.com" ], "title": "Company Website" }, "created_at": { "description": "When the lead was created", "examples": [ "2024-01-15T10:30:00Z" ], "format": "date-time", "title": "Created At", "type": "string" }, "custom_fields": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Custom fields as key-value pairs", "title": "Custom Fields" }, "delivered_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "When a lead-database result was delivered to your workspace; null for leads from other sources", "examples": [ "2026-09-01T09:00:00Z" ], "title": "Delivered At" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Lead's email address", "examples": [ "sarah.johnson@acmecorp.com" ], "title": "Email" }, "employees": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of employees at the company", "examples": [ 150 ], "title": "Employees" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Lead's first name", "examples": [ "Sarah" ], "title": "First Name" }, "id": { "description": "Lead UUID", "examples": [ "a1b2c3d4-e5f6-7890-abcd-ef1234567890" ], "title": "Id", "type": "string" }, "industry": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Industry sector", "examples": [ "Technology" ], "title": "Industry" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Lead's last name", "examples": [ "Johnson" ], "title": "Last Name" }, "linkedin_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Lead's LinkedIn profile URL", "examples": [ "https://linkedin.com/in/sarahjohnson" ], "title": "Linkedin Url" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Phone number", "examples": [ "+1-555-123-4567" ], "title": "Phone Number" }, "qualification_score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Lead qualification score (0-100)", "examples": [ 85.5 ], "title": "Qualification Score" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Where the lead came from: `lead_database` for a licensed lead-database result, `csv` for an upload, `manual` for one entered by hand, `linkedin_search` for a LinkedIn search; null for leads recorded before sources were tracked", "examples": [ "lead_database" ], "title": "Source" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Job title", "examples": [ "VP of Sales" ], "title": "Title" } }, "required": [ "id", "created_at" ], "title": "LeadDetail", "type": "object" }, "PersonalizationField": { "additionalProperties": true, "properties": { "error": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Runs that failed", "title": "Error" }, "fallback": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Runs that used the field's fallback text", "title": "Fallback" }, "field_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Field Name" }, "generic": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Runs whose output was judged generic", "title": "Generic" }, "held": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Runs held back rather than sent", "title": "Held" }, "held_rate_pct": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "(held + generic + error) / runs: the share of sends with no usable copy; null when there were no runs", "title": "Held Rate Pct" }, "insufficient_data": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Runs where the model reported too little to work with", "title": "Insufficient Data" }, "insufficient_data_rate_pct": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "insufficient_data / runs; null when there were no runs", "title": "Insufficient Data Rate Pct" }, "runs": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Live sends where the field was resolved", "title": "Runs" }, "success": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Runs that produced personalised copy", "title": "Success" } }, "title": "PersonalizationField", "type": "object" }, "Pipeline": { "description": "Sales pipeline view.", "properties": { "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "When the pipeline was created", "examples": [ "2024-01-15T10:30:00Z" ], "title": "Created At" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Pipeline ID", "examples": [ "c1d2e3f4-a5b6-7890-cdef-123456789012" ], "title": "Id" }, "is_active": { "default": true, "description": "Whether this pipeline is active", "title": "Is Active", "type": "boolean" }, "is_default": { "default": false, "description": "Whether this is the default pipeline", "title": "Is Default", "type": "boolean" }, "name": { "description": "Pipeline name", "examples": [ "Enterprise Sales" ], "title": "Name", "type": "string" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "When the pipeline was last updated", "examples": [ "2024-01-20T14:45:00Z" ], "title": "Updated At" } }, "required": [ "name" ], "title": "Pipeline", "type": "object" }, "ResponderAsset": { "properties": { "description": { "maxLength": 300, "title": "Description", "type": "string" }, "link": { "description": "https:// URL", "maxLength": 2000, "title": "Link", "type": "string" } }, "required": [ "description", "link" ], "title": "ResponderAsset", "type": "object" }, "ResponderConfig": { "additionalProperties": true, "properties": { "agent_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Agent Name" }, "agent_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Agent Version" }, "assets": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Assets" }, "campaign_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Campaign Description" }, "campaign_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Campaign Id" }, "company_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Company Name" }, "custom_instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Custom Instructions" }, "first_message_mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "First Message Mode" }, "goal": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Goal" }, "goal_link": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Goal Link" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "is_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Is Enabled" }, "max_replies": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Max Replies" }, "mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Mode" }, "tone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tone" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated At" } }, "title": "ResponderConfig", "type": "object" }, "SenderBreakdownRow": { "additionalProperties": true, "properties": { "acceptance_rate_pct": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "accepted / requests; null when none were sent", "title": "Acceptance Rate Pct" }, "accepted": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "LinkedIn connection requests accepted", "title": "Accepted" }, "account_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The connected account's id, when it is still connected", "title": "Account Id" }, "contacted_leads": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Contacted Leads" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the account is connected now", "title": "Is Active" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The sender's display name or address", "title": "Label" }, "messages_sent": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Messages Sent" }, "platform": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "'email' or 'linkedin'", "title": "Platform" }, "positive_leads": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Positive Leads" }, "positive_rate_pct": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "positive_leads / contacted_leads; null when nobody was contacted", "title": "Positive Rate Pct" }, "replied_leads": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Replied Leads" }, "reply_rate_pct": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "replied_leads / contacted_leads; null when nobody was contacted", "title": "Reply Rate Pct" }, "requests": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "LinkedIn connection requests sent", "title": "Requests" }, "sender_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Stable key for the sender: the provider account id", "title": "Sender Key" } }, "title": "SenderBreakdownRow", "type": "object" }, "Stage": { "description": "Sales pipeline stage.", "properties": { "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "When the stage was created", "examples": [ "2024-01-15T10:30:00Z" ], "title": "Created At" }, "display_order": { "description": "Order in which the stage appears (lower = earlier)", "examples": [ 2 ], "title": "Display Order", "type": "integer" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Stage ID", "examples": [ "d2e3f4a5-b6c7-8901-def0-234567890123" ], "title": "Id" }, "is_active": { "default": true, "description": "Whether this stage is active", "title": "Is Active", "type": "boolean" }, "name": { "description": "Stage name", "examples": [ "Qualified" ], "title": "Name", "type": "string" }, "pipeline_id": { "description": "ID of the parent pipeline", "examples": [ "c1d2e3f4-a5b6-7890-cdef-123456789012" ], "title": "Pipeline Id", "type": "string" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "When the stage was last updated", "examples": [ "2024-01-20T14:45:00Z" ], "title": "Updated At" } }, "required": [ "pipeline_id", "name", "display_order" ], "title": "Stage", "type": "object" }, "StepFunnelStep": { "additionalProperties": true, "properties": { "channel": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "'email' or 'linkedin'", "enum": [ "email", "linkedin", null ], "title": "Channel" }, "day": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The day of the sequence the step falls on", "title": "Day" }, "is_message_step": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the step sends something a prospect can reply to", "title": "Is Message Step" }, "lane": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "'main', or 'yes' / 'no' for the branch of a connection check", "enum": [ "main", "yes", "no" ], "title": "Lane" }, "position": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The orchestrator's step number, counted from 1", "title": "Position" }, "positive": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Positive replies credited to this step", "title": "Positive" }, "positive_rate_pct": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "positive / reached; null when nobody reached it", "title": "Positive Rate Pct" }, "reached": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Leads that reached this step in the window", "title": "Reached" }, "replied": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Replies credited to this step", "title": "Replied" }, "reply_rate_pct": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "replied / reached; null when nobody reached it", "title": "Reply Rate Pct" }, "step_id": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" }, { "type": "null" } ], "default": null, "description": "The sequence step's id at this position, when it could be matched. An integer on current sequences; older sequences may hold a fractional number or a string.", "title": "Step Id" }, "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The email subject; only on email steps", "title": "Subject" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The step type at this position", "title": "Type" }, "waiting": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Leads currently sitting at this step (current state; ignores the window)", "title": "Waiting" } }, "title": "StepFunnelStep", "type": "object" }, "WebhookExampleAIResponse": { "description": "The responder's reading of the reply.\n\nWhen the responder did not run for this reply (disabled, or skipped),\nevery field is null except `goal`, which carries the reason.", "properties": { "agent_action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "What the agent did with the reply: 'reply', 'wait', 'nudge', 'escalate', 'close' or 'skip'", "examples": [ "reply" ], "title": "Agent Action" }, "agent_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Present (as 2) when the Appointment Setter agent handled the reply; absent on legacy payloads. Feature-detect on this field", "examples": [ 2 ], "title": "Agent Version" }, "asset_delivered": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Asset-first campaigns only: whether the page went out", "examples": [ true ], "title": "Asset Delivered" }, "asset_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Asset-first campaigns only: the personalised page that was sent", "examples": [ "https://pages.example.com/p/abc123" ], "title": "Asset Url" }, "complete": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the conversation reached its goal", "examples": [ false ], "title": "Complete" }, "conversation_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Conversation state after this reply: 'awaiting_prospect', 'awaiting_followup', 'closed_won', 'closed_lost', 'closed_escalated' or 'closed_no_response'", "examples": [ "awaiting_prospect" ], "title": "Conversation Status" }, "escalation_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Why the agent handed the conversation to a human, when it did", "examples": [ null ], "title": "Escalation Reason" }, "first_message_mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Asset-first campaigns only: how the first message was sent", "examples": [ "asset" ], "title": "First Message Mode" }, "goal": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The campaign goal the responder is working toward, or the skip reason", "examples": [ "Schedule a demo" ], "title": "Goal" }, "goal_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Progress toward the meeting goal: 'not_sent', 'link_sent', 'soft_commit', 'confirmed' or 'declined'", "examples": [ "link_sent" ], "title": "Goal Status" }, "out_of_office": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "examples": [ false ], "title": "Out Of Office" }, "responder_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The reply the responder sent, or null when nothing was sent", "examples": [ "Thank you for your interest! I'd be happy to schedule a demo for you." ], "title": "Responder Message" }, "sdr_brief": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "examples": [ "Prospect expressed interest, recommend scheduling demo within 24 hours." ], "title": "Sdr Brief" }, "sentiment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "'positive', 'neutral' or 'negative'", "examples": [ "positive" ], "title": "Sentiment" } }, "title": "WebhookExampleAIResponse", "type": "object" }, "WebhookExampleLead": { "description": "The lead as stored. Any field the lead lacks is null.", "properties": { "annual_revenue": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "examples": [ 5000000 ], "title": "Annual Revenue" }, "company": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "examples": [ "Example Corp" ], "title": "Company" }, "custom_fields": { "additionalProperties": true, "examples": [ { "product_interest": "Enterprise Plan", "region": "North America" } ], "title": "Custom Fields", "type": "object" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "examples": [ "john.doe@example.com" ], "title": "Email" }, "employee_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "examples": [ 50 ], "title": "Employee Count" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "examples": [ "John" ], "title": "First Name" }, "industry": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "examples": [ "Technology" ], "title": "Industry" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "examples": [ "Doe" ], "title": "Last Name" }, "linkedin_profile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The lead's LinkedIn profile URL", "examples": [ "https://linkedin.com/in/johndoe" ], "title": "Linkedin Profile" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "examples": [ "VP of Sales" ], "title": "Title" }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The lead's company website", "examples": [ "https://example.com" ], "title": "Website" } }, "title": "WebhookExampleLead", "type": "object" }, "WebhookExamplePayload": { "description": "The payload delivered to a campaign webhook when a prospect replies.\n\nDeliveries are retried (up to 5 attempts over 48 hours) until the\nreceiver answers 2xx, so the same reply can arrive more than once:\ndeduplicate on `idempotency_key`, which is identical on every redelivery.", "properties": { "ai_response": { "$ref": "#/components/schemas/WebhookExampleAIResponse", "description": "The responder's reading of the reply" }, "campaign": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Campaign name", "examples": [ "Q1 2024 Outbound Campaign" ], "title": "Campaign" }, "channel": { "description": "Communication channel: 'email' or 'linkedin'", "examples": [ "email" ], "title": "Channel", "type": "string" }, "conversation_owner": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Present only when the conversation has an owner: 'victoria' when Victoria's responder is handling replies, 'lp_responder' when an external responder is. Receivers that reply to prospects themselves should stay out of conversations Victoria owns", "examples": [ "victoria" ], "title": "Conversation Owner" }, "event": { "description": "Event type", "examples": [ "prospect_response" ], "title": "Event", "type": "string" }, "idempotency_key": { "description": "SHA-256 hex digest (64 characters) of the sequence lead, campaign, channel and prospect message. Identical on every redelivery of the same reply; a different reply from the same prospect gets a new key", "examples": [ "f3a1c9d2b8e7460a91d0a25f3e7b4c1d6f8a92e0b4c1d6f8a92e0b4c1d6f8a92" ], "maxLength": 64, "minLength": 64, "title": "Idempotency Key", "type": "string" }, "lead": { "$ref": "#/components/schemas/WebhookExampleLead", "description": "Lead details" }, "prospect_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The prospect's reply, as received", "examples": [ "Hi, I'm interested in learning more about your product." ], "title": "Prospect Message" }, "sender": { "$ref": "#/components/schemas/WebhookExampleSender", "description": "Assigned sending accounts for this sequence lead, keyed by channel" }, "sequence_lead_id": { "description": "ID of the sequence lead this response relates to", "examples": [ "550e8400-e29b-41d4-a716-446655440000" ], "format": "uuid", "title": "Sequence Lead Id", "type": "string" }, "timestamp": { "description": "When the delivery was built: ISO 8601, UTC, with a `+00:00` offset and microseconds", "examples": [ "2025-01-14T19:30:00.123456+00:00" ], "title": "Timestamp", "type": "string" }, "variation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "A/B arm the lead is in: 'a', 'b', or null when the lead has none", "examples": [ "a" ], "title": "Variation" } }, "required": [ "event", "idempotency_key", "sequence_lead_id", "timestamp", "channel", "sender", "lead", "ai_response" ], "title": "WebhookExamplePayload", "type": "object" }, "WebhookExampleSender": { "description": "Assigned sending accounts for the sequence lead. Either, both, or neither key may be present.", "properties": { "email": { "anyOf": [ { "$ref": "#/components/schemas/WebhookExampleSenderEmail" }, { "type": "null" } ], "default": null, "description": "Present when the lead has an email account assigned" }, "linkedin": { "anyOf": [ { "$ref": "#/components/schemas/WebhookExampleSenderLinkedIn" }, { "type": "null" } ], "default": null, "description": "Present when the lead has a LinkedIn account assigned" } }, "title": "WebhookExampleSender", "type": "object" }, "WebhookExampleSenderEmail": { "description": "Email sender account (assigned to this sequence lead).", "properties": { "account_id": { "description": "Unipile account ID for the email account", "examples": [ "xyz789-unipile-id" ], "title": "Account Id", "type": "string" }, "email": { "description": "Sender email address", "examples": [ "jane@yourcompany.com" ], "title": "Email", "type": "string" }, "platform_username": { "description": "Account username (typically the address)", "examples": [ "jane@yourcompany.com" ], "title": "Platform Username", "type": "string" } }, "required": [ "account_id", "platform_username", "email" ], "title": "WebhookExampleSenderEmail", "type": "object" }, "WebhookExampleSenderLinkedIn": { "description": "LinkedIn sender account (assigned to this sequence lead).", "properties": { "account_id": { "description": "Unipile account ID for the LinkedIn account", "examples": [ "abc123-unipile-id" ], "title": "Account Id", "type": "string" }, "platform_username": { "description": "LinkedIn username/handle", "examples": [ "jane-smith-sdr" ], "title": "Platform Username", "type": "string" } }, "required": [ "account_id", "platform_username" ], "title": "WebhookExampleSenderLinkedIn", "type": "object" }, "WebhookRecord": { "description": "A single webhook subscription record.", "properties": { "created_at": { "description": "When this webhook was created", "examples": [ "2024-01-15T10:30:00Z" ], "title": "Created At", "type": "string" }, "id": { "description": "Webhook subscription ID", "examples": [ "550e8400-e29b-41d4-a716-446655440000" ], "title": "Id", "type": "string" }, "is_enabled": { "description": "Whether this webhook is currently active", "examples": [ true ], "title": "Is Enabled", "type": "boolean" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "When this webhook was last updated", "examples": [ "2024-01-20T14:45:00Z" ], "title": "Updated At" }, "webhook_url": { "description": "URL that receives webhook events", "examples": [ "https://api.example.com/webhooks/victoria" ], "title": "Webhook Url", "type": "string" } }, "required": [ "id", "webhook_url", "is_enabled", "created_at" ], "title": "WebhookRecord", "type": "object" } }, "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "API Key", "description": "API key authentication. Obtain your API key from the Victoria AI dashboard. The scope an operation requires is listed against this scheme in its `security` entry; a key with `*` holds every scope." } }, "headers": { "X-Request-ID": { "description": "Correlation id for this request; also in every error body. Quote it to support.", "schema": { "type": "string" } }, "RateLimit-Limit": { "description": "Requests allowed on this endpoint per window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } }, "Idempotent-Replay": { "description": "'true' when this response was replayed from an earlier request that sent the same Idempotency-Key.", "schema": { "type": "string", "enum": [ "true" ] } }, "Deprecation": { "description": "'true': this route is deprecated (RFC 8594). Move to the path in the Link header.", "schema": { "type": "string", "enum": [ "true" ] } }, "Sunset": { "description": "HTTP-date after which a deprecated route may stop working. Sent only once a date has been set.", "schema": { "type": "string" } }, "Link": { "description": "`; rel=\"successor-version\"`: the route that replaces a deprecated one.", "schema": { "type": "string" } } }, "parameters": { "IdempotencyKey": { "name": "Idempotency-Key", "in": "header", "required": false, "description": "Any unique string (a UUID is ideal). A repeat of this request with the same key returns the original response, marked `Idempotent-Replay: true`, without doing the work again. Keys are scoped to your organization and remembered for 24 hours. Optional.", "schema": { "type": "string", "minLength": 1, "maxLength": 255 } } } }, "info": { "title": "Victoria AI API", "version": "1.0.0", "description": "\nVictoria AI provides a REST API for managing leads, campaigns, and CRM data programmatically.\n\n## Authentication\n\nAll API requests require authentication using a Bearer token. Include your API key in the Authorization header:\n\n```\nAuthorization: Bearer YOUR_API_KEY\n```\n\nObtain your API key from the Victoria AI dashboard under Settings > API Keys.\n\n## Scopes\n\nA key carries scopes. Each operation below names the scope it requires (in its\n`security` entry and at the end of its description); a key with `*` holds every\nscope. Families: `leads`, `campaigns`, `crm`, `accounts`, each\nas `:read` or `:write`. A `:write` scope implies the family's `:read`. A key\nwithout the scope answers `403 INSUFFICIENT_SCOPE`.\n\n## Rate Limits\n\nLimits apply per API key (per client IP for unauthenticated requests):\n\n- Each endpoint: 100 requests per minute\n- All endpoints combined: 600 requests per minute\n\nEvery response carries the standard rate-limit headers:\n- `RateLimit-Limit`: requests allowed on this endpoint per window\n- `RateLimit-Remaining`: requests remaining in the current window\n- `RateLimit-Reset`: seconds until the window resets\n\nA rejected request answers `429` with a `Retry-After` header.\n\n## Idempotency\n\nRetrying a write is safe if you send an `Idempotency-Key` header. A timeout\nlooks the same whether the request failed or succeeded and lost the response,\nso a retry without one can create a second lead, campaign or deal.\n\nSend any unique string (a UUID is ideal, 255 characters max) on `POST /leads`,\n`POST /campaigns` or `POST /crm/deals`. The first request runs normally; a\nrepeat with the same key returns the original response, marked\n`Idempotent-Replay: true`, without doing the work again. Keys are scoped to\nyour organization and remembered for 24 hours.\n\nUse a fresh key for each distinct request. Reusing one with a different body\nanswers `409 IDEMPOTENCY_KEY_REUSED` rather than returning an unrelated\nresult, and a key whose first request is still running answers\n`409 IDEMPOTENCY_IN_PROGRESS` with `Retry-After`. Server errors do not consume\na key, so a retry after a `5xx` runs normally.\n\nThe header is optional; omit it and nothing changes.\n\n## Deprecated routes\n\nA route marked deprecated still works. Every response from it carries\n`Deprecation: true` and `Link: ; rel=\"successor-version\"` naming its\nreplacement (RFC 8594). A `Sunset` date is sent once one has been set; none\nhas been yet.\n\n## Response headers\n\nEvery response carries `X-Request-ID` and the three `RateLimit-*` headers.\nBrowsers may read `X-Request-ID`, `RateLimit-Limit`, `RateLimit-Remaining`, `RateLimit-Reset`, `Retry-After`, `Idempotent-Replay`, `Deprecation`, `Sunset`, `Link`.\n\n## Errors\n\nThe API uses standard HTTP status codes:\n- `200` - Success\n- `201` - Created\n- `400` - Bad Request (invalid parameters; `details.errors` lists each field)\n- `401` - Unauthorized (missing, invalid, or expired API key)\n- `403` - Forbidden (the key lacks the required scope, or the organization is deactivated)\n- `404` - Not Found\n- `405` - Method Not Allowed\n- `409` - Conflict (duplicate resource, or the resource changed since it was read)\n- `413` - Payload Too Large\n- `429` - Too Many Requests (rate limited)\n- `500` - Internal Server Error\n- `503` - Service Unavailable (authentication store or an upstream dependency timed out; retry)\n\nEvery error response is a JSON body with `success: false`, a stable `error` code,\na human-readable `message`, optional `details`, and a `request_id` -- also sent as\nthe `X-Request-ID` header -- to quote when contacting support.\n" }, "openapi": "3.1.0", "paths": { "/accounts": { "get": { "description": "\nEvery LinkedIn/email account connected for outreach, with its status:\nis_active=false means the account was disconnected (usually an auth error)\nand needs the reconnect flow. Includes the identity ids the /connect\nreconnect endpoints require.\n\nRequires the `accounts:read` scope (or `*`).", "operationId": "get_list_accounts", "parameters": [ { "description": "Maximum rows to return", "in": "query", "name": "limit", "schema": { "default": 500, "maximum": 500, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "Rows to skip before returning results", "in": "query", "name": "offset", "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Response for the connected-accounts listing.", "properties": { "accounts": { "items": { "$ref": "#/components/schemas/ConnectedAccount" }, "title": "Accounts", "type": "array" }, "count": { "default": 0, "description": "Accounts in this page. Deprecated: use `total`", "title": "Count", "type": "integer" }, "has_more": { "description": "Whether a further page exists", "title": "Has More", "type": "boolean" }, "limit": { "description": "Page size that was applied", "title": "Limit", "type": "integer" }, "offset": { "description": "Rows skipped before this page", "title": "Offset", "type": "integer" }, "success": { "default": true, "title": "Success", "type": "boolean" }, "total": { "description": "Total rows matching the query, across all pages", "title": "Total", "type": "integer" } }, "required": [ "total", "limit", "offset", "has_more" ], "title": "GetAccountsResponse", "type": "object" } } }, "description": "Response for the connected-accounts listing.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "List connected sender accounts.", "tags": [ "Accounts" ], "security": [ { "BearerAuth": [ "accounts:read" ] } ], "x-required-scope": "accounts:read" } }, "/accounts/connect-link": { "post": { "description": "\nSend it to the person whose LinkedIn or mailbox it is; they sign in on the\nhosted page, and the account appears in GET /v1/accounts once connected.\nWith reconnect_account_id it re-authenticates an existing account that\ndisconnected (is_active=false) instead of adding one. A new account needs a\nfree seat for its platform, or this returns ACCOUNT_LIMIT_REACHED. Links\nexpire after about a week.\n\nRequires the `accounts:write` scope (or `*`).", "operationId": "post_connect_link", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "description": "Request body for minting a sender connect link.", "properties": { "display_name": { "description": "The name the account is labelled with, usually its owner's", "maxLength": 120, "title": "Display Name", "type": "string" }, "email": { "anyOf": [ { "maxLength": 254, "type": "string" }, { "type": "null" } ], "default": null, "description": "The mailbox address; required for email", "title": "Email" }, "failure_redirect_url": { "anyOf": [ { "maxLength": 2000, "type": "string" }, { "type": "null" } ], "default": null, "description": "Where to send the user if connecting fails; defaults to the success URL", "title": "Failure Redirect Url" }, "platform": { "description": "Which kind of sender account to connect", "enum": [ "linkedin", "email" ], "title": "Platform", "type": "string" }, "reconnect_account_id": { "anyOf": [ { "maxLength": 120, "type": "string" }, { "type": "null" } ], "default": null, "description": "Reconnect this existing account (its id or its provider account id) instead of adding a new one", "title": "Reconnect Account Id" }, "success_redirect_url": { "anyOf": [ { "maxLength": 2000, "type": "string" }, { "type": "null" } ], "default": null, "description": "Where to send the user after connecting; must be an allowed https origin", "title": "Success Redirect Url" } }, "required": [ "platform", "display_name" ], "title": "ConnectLinkRequest", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "A hosted link the account owner opens to connect or reconnect.", "properties": { "expires_at": { "description": "ISO timestamp after which the link stops working (about a week)", "title": "Expires At", "type": "string" }, "platform": { "enum": [ "linkedin", "email" ], "title": "Platform", "type": "string" }, "success": { "default": true, "title": "Success", "type": "boolean" }, "type": { "enum": [ "create", "reconnect" ], "title": "Type", "type": "string" }, "url": { "description": "Open this to connect; it signs the account into this organization", "title": "Url", "type": "string" } }, "required": [ "platform", "url", "type", "expires_at" ], "title": "ConnectLinkResponse", "type": "object" } } }, "description": "A hosted link the account owner opens to connect or reconnect.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "400": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "409": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "Mint a link that connects a sender account to this organization.", "tags": [ "Accounts" ], "security": [ { "BearerAuth": [ "accounts:write" ] } ], "x-required-scope": "accounts:write" } }, "/auth/verify": { "get": { "description": "\nUse this endpoint to test your API key and confirm authentication is working.\nReturns the organization ID and name associated with the API key.", "operationId": "get_verify_auth", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Response from auth verification endpoint.", "properties": { "message": { "description": "Status message", "examples": [ "API key is valid" ], "title": "Message", "type": "string" }, "organization_id": { "description": "Organization ID associated with this API key", "examples": [ "123e4567-e89b-12d3-a456-426614174000" ], "title": "Organization Id", "type": "string" }, "organization_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Organization name", "examples": [ "Acme Corporation" ], "title": "Organization Name" }, "success": { "description": "Whether the API key is valid", "examples": [ true ], "title": "Success", "type": "boolean" } }, "required": [ "success", "message", "organization_id" ], "title": "AuthVerifyResponse", "type": "object" } } }, "description": "Response from auth verification endpoint.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "Verify API key and return organization details.", "tags": [ "Auth" ], "security": [ { "BearerAuth": [] } ] } }, "/campaigns": { "get": { "description": "\nOrdered newest first and paginated with `limit`/`offset`; page while\n`has_more` is true. The default page size holds every campaign any\norganization currently has.\n\nRequires the `campaigns:read` scope (or `*`).", "operationId": "get_list_campaigns", "parameters": [ { "description": "Maximum rows to return", "in": "query", "name": "limit", "schema": { "default": 500, "maximum": 500, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "Rows to skip before returning results", "in": "query", "name": "offset", "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Response for campaigns retrieval.", "properties": { "campaigns": { "description": "List of campaigns found", "items": { "$ref": "#/components/schemas/Campaign" }, "title": "Campaigns", "type": "array" }, "count": { "description": "Campaigns in this page. Deprecated: use `total`", "title": "Count", "type": "integer" }, "has_more": { "description": "Whether a further page exists", "title": "Has More", "type": "boolean" }, "limit": { "description": "Page size that was applied", "title": "Limit", "type": "integer" }, "message": { "title": "Message", "type": "string" }, "offset": { "description": "Rows skipped before this page", "title": "Offset", "type": "integer" }, "success": { "default": true, "title": "Success", "type": "boolean" }, "total": { "description": "Total rows matching the query, across all pages", "title": "Total", "type": "integer" } }, "required": [ "total", "limit", "offset", "has_more", "message", "campaigns", "count" ], "title": "GetCampaignsResponse", "type": "object" } } }, "description": "Response for campaigns retrieval.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "400": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "Get campaigns for an organization.", "tags": [ "Campaigns" ], "security": [ { "BearerAuth": [ "campaigns:read" ] } ], "x-required-scope": "campaigns:read" }, "post": { "description": "\nThe campaign is created with is_active=false; activate it with\nPATCH /v1/campaigns/{campaign_id} once its sequence and leads are ready.\nAn optional sequence is validated against the structural rules before saving.\n\nRequires the `campaigns:write` scope (or `*`).", "operationId": "post_create_campaign_route", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Request body for creating a draft campaign.", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "", "description": "Campaign description", "title": "Description" }, "name": { "description": "Campaign name", "examples": [ "Q3 Proof First Outreach" ], "title": "Name", "type": "string" }, "sequence": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Optional full sequence object (variation_a / variation_b step arrays); validated against structural rules", "title": "Sequence" } }, "required": [ "name" ], "title": "CreateCampaignRequest", "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "description": "Response for campaign creation.", "properties": { "campaign": { "anyOf": [ { "$ref": "#/components/schemas/CampaignDetail" }, { "type": "null" } ], "default": null, "description": "The created campaign" }, "campaign_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "UUID of the created campaign", "title": "Campaign Id" }, "message": { "default": "Campaign created in draft state", "title": "Message", "type": "string" }, "success": { "default": true, "title": "Success", "type": "boolean" } }, "title": "CreateCampaignResponse", "type": "object" } } }, "description": "Response for campaign creation.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Idempotent-Replay": { "$ref": "#/components/headers/Idempotent-Replay" } } }, "400": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "409": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints. Also `IDEMPOTENCY_KEY_REUSED` (the key was used with a different request) and `IDEMPOTENCY_IN_PROGRESS` (its first request is still running; carries `Retry-After`).", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "Create a draft campaign.", "tags": [ "Campaigns" ], "security": [ { "BearerAuth": [ "campaigns:write" ] } ], "x-required-scope": "campaigns:write" } }, "/campaigns/sequence-templates": { "get": { "deprecated": true, "description": "\nNot scoped to a campaign, despite sitting under /campaigns.\n\nRequires the `campaigns:read` scope (or `*`).", "operationId": "get_get_sequence_templates_deprecated", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Blank sequence skeletons for building campaign sequences.", "properties": { "success": { "default": true, "title": "Success", "type": "boolean" }, "templates": { "additionalProperties": true, "description": "channel_type -> blank sequence skeleton (multichannel, linkedin_only, email_only)", "title": "Templates", "type": "object" } }, "required": [ "templates" ], "title": "SequenceTemplatesResponse", "type": "object" } } }, "description": "Blank sequence skeletons for building campaign sequences.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Link": { "$ref": "#/components/headers/Link" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Link": { "$ref": "#/components/headers/Link" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Link": { "$ref": "#/components/headers/Link" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Link": { "$ref": "#/components/headers/Link" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Link": { "$ref": "#/components/headers/Link" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Link": { "$ref": "#/components/headers/Link" } } } }, "summary": "Blank sequence skeletons. Deprecated: use GET /v1/sequence-templates.", "tags": [ "Campaigns" ], "security": [ { "BearerAuth": [ "campaigns:read" ] } ], "x-required-scope": "campaigns:read" } }, "/campaigns/webhook/examples": { "get": { "deprecated": true, "description": "\nNot scoped to a campaign, despite sitting under /campaigns. Serves the same\npayloads as its replacement, whose documentation describes delivery,\nretries and signing.\n\nRequires the `campaigns:read` scope (or `*`).", "operationId": "get_get_webhook_examples_deprecated", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Response containing example webhook payloads for testing.", "properties": { "examples": { "description": "Array of example webhook payloads", "items": { "$ref": "#/components/schemas/WebhookExamplePayload" }, "title": "Examples", "type": "array" }, "success": { "default": true, "title": "Success", "type": "boolean" } }, "required": [ "examples" ], "title": "WebhookExamplesResponse", "type": "object" } } }, "description": "Response containing example webhook payloads for testing.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Link": { "$ref": "#/components/headers/Link" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Link": { "$ref": "#/components/headers/Link" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Link": { "$ref": "#/components/headers/Link" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Link": { "$ref": "#/components/headers/Link" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Link": { "$ref": "#/components/headers/Link" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Link": { "$ref": "#/components/headers/Link" } } } }, "summary": "Example webhook payloads. Deprecated: use GET /v1/webhooks/examples.", "tags": [ "Campaigns" ], "security": [ { "BearerAuth": [ "campaigns:read" ] } ], "x-required-scope": "campaigns:read" } }, "/campaigns/{campaign_id}": { "get": { "description": "\nRetrieve detailed information about a specific campaign including\nits configuration, status, and sequence steps.\n\nRequires the `campaigns:read` scope (or `*`).", "operationId": "get_get_campaign", "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Response for single campaign lookup.", "properties": { "campaign": { "$ref": "#/components/schemas/CampaignDetail", "description": "Campaign details" }, "success": { "default": true, "title": "Success", "type": "boolean" } }, "required": [ "campaign" ], "title": "GetCampaignByIdResponse", "type": "object" } } }, "description": "Response for single campaign lookup.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "404": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "Get campaign details by ID.", "tags": [ "Campaigns" ], "security": [ { "BearerAuth": [ "campaigns:read" ] } ], "x-required-scope": "campaigns:read" }, "patch": { "description": "\nActivating (`is_active: true`) runs the readiness preflight first -- the\nsequence, its variables, lead data, assigned sender accounts, sender email\nauthentication and the subscription. A blocking check answers 409\nCAMPAIGN_NOT_READY with each check under `details.checks`; warnings alone\nanswer 409 CAMPAIGN_ACTIVATION_WARNINGS until the request is repeated with\n`ack_warnings: true`. Pausing never runs the preflight.\n\nRequires the `campaigns:write` scope (or `*`).", "operationId": "patch_update_campaign_route", "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Request body for patching a campaign. is_active is activate/pause.", "properties": { "ack_warnings": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "With is_active=true: accept the non-blocking warnings the preflight reported (a CAMPAIGN_ACTIVATION_WARNINGS response lists them under details.checks) and activate anyway.", "title": "Ack Warnings" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "New description", "title": "Description" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Activate (true) or pause (false) the campaign. Activation runs the readiness preflight: a blocking check answers 409 CAMPAIGN_NOT_READY, warnings alone answer 409 CAMPAIGN_ACTIVATION_WARNINGS until acknowledged with ack_warnings.", "title": "Is Active" }, "lead_database_filters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Replace the campaign's saved lead-database ICP filters", "title": "Lead Database Filters" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "New campaign name", "title": "Name" }, "refill_policy": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Replace the auto-refill policy (send {enabled:false} to disable; null is ignored)", "title": "Refill Policy" }, "responder_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Toggle the AI auto-responder", "title": "Responder Enabled" } }, "title": "UpdateCampaignRequest", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Response for a campaign patch.", "properties": { "campaign": { "anyOf": [ { "$ref": "#/components/schemas/CampaignDetail" }, { "type": "null" } ], "default": null, "description": "The updated campaign" }, "message": { "default": "Campaign updated", "title": "Message", "type": "string" }, "success": { "default": true, "title": "Success", "type": "boolean" } }, "title": "UpdateCampaignResponse", "type": "object" } } }, "description": "Response for a campaign patch.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "400": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "404": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "409": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "Update a campaign's name, description, is_active (activate/pause), or responder toggle.", "tags": [ "Campaigns" ], "security": [ { "BearerAuth": [ "campaigns:write" ] } ], "x-required-scope": "campaigns:write" } }, "/campaigns/{campaign_id}/ab-cohorts": { "get": { "description": "\nEach lead counts once, in the arm it was assigned, with its first reply,\nfirst positive and first negative. Unlike /analysis, every number is over\nthe same set of leads, so the arms can be compared directly.\n\nRequires the `campaigns:read` scope (or `*`).", "operationId": "get_ab_cohorts_route", "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "ISO timestamp the test started; only leads first contacted at or after it count", "in": "query", "name": "since", "required": true, "schema": { "title": "Since", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Per-variation counts for leads first contacted since the test began: each lead once, by its assigned arm.", "properties": { "arms": { "additionalProperties": { "additionalProperties": { "type": "integer" }, "type": "object" }, "description": "a / b -> {contacted, replied, positive, negative}", "title": "Arms", "type": "object" }, "campaign_id": { "title": "Campaign Id", "type": "string" }, "since": { "title": "Since", "type": "string" }, "success": { "default": true, "title": "Success", "type": "boolean" } }, "required": [ "campaign_id", "since" ], "title": "AbCohortsResponse", "type": "object" } } }, "description": "Per-variation counts for leads first contacted since the test began: each lead once, by its assigned arm.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "400": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "404": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "How each A/B variation is doing, for leads first contacted since the test began.", "tags": [ "Campaigns" ], "security": [ { "BearerAuth": [ "campaigns:read" ] } ], "x-required-scope": "campaigns:read" } }, "/campaigns/{campaign_id}/ab-testing": { "post": { "description": "\nTurning it on needs a variation_b with steps (409 VARIATION_B_MISSING).\nLeads already enrolled keep their arm.\n\nRequires the `campaigns:write` scope (or `*`).", "operationId": "post_set_ab_testing_route", "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Request body for switching an A/B test on or off.", "properties": { "enabled": { "description": "true runs the test; false sends every new lead variation A", "title": "Enabled", "type": "boolean" }, "traffic_split": { "default": 50, "description": "Percentage of NEW leads that get variation A (the rest get B)", "maximum": 100, "minimum": 0, "title": "Traffic Split", "type": "integer" } }, "required": [ "enabled" ], "title": "SetAbTestingRequest", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ab_testing_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Ab Testing Enabled" }, "campaign_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Campaign Id" }, "message": { "title": "Message", "type": "string" }, "success": { "default": true, "title": "Success", "type": "boolean" }, "traffic_split": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Traffic Split" }, "winner": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Winner" } }, "required": [ "message" ], "title": "AbTestingResponse", "type": "object" } } }, "description": "", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "400": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "404": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "409": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "Turn an A/B test on or off and set the share of new leads that get variation A.", "tags": [ "Campaigns" ], "security": [ { "BearerAuth": [ "campaigns:write" ] } ], "x-required-scope": "campaigns:write" } }, "/campaigns/{campaign_id}/ab-testing/promote": { "post": { "description": "\nwinner a: every new lead gets A. winner b: B's steps are copied over A\n(fresh step ids) and every new lead gets them. Neither arm is deleted, and\nA/B stays enabled so leads in flight finish the copy they started. 409\nAB_TESTING_DISABLED when no test is running; SEQUENCE_MODIFIED when the\ncampaign changed underneath the promotion.\n\nRequires the `campaigns:write` scope (or `*`).", "operationId": "post_promote_ab_winner_route", "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Request body for ending an A/B test in one arm's favour.", "properties": { "winner": { "description": "a: every new lead gets A. b: B's steps are copied over A and every new lead gets them; leads in flight on A continue on B's remaining steps. Leads already on B finish B either way.", "enum": [ "a", "b" ], "title": "Winner", "type": "string" } }, "required": [ "winner" ], "title": "PromoteAbWinnerRequest", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ab_testing_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Ab Testing Enabled" }, "campaign_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Campaign Id" }, "message": { "title": "Message", "type": "string" }, "success": { "default": true, "title": "Success", "type": "boolean" }, "traffic_split": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Traffic Split" }, "winner": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Winner" } }, "required": [ "message" ], "title": "AbTestingResponse", "type": "object" } } }, "description": "", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "400": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "404": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "409": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "End an A/B test in one arm's favour.", "tags": [ "Campaigns" ], "security": [ { "BearerAuth": [ "campaigns:write" ] } ], "x-required-scope": "campaigns:write" } }, "/campaigns/{campaign_id}/ai-fields": { "get": { "description": "Requires the `campaigns:read` scope (or `*`).", "operationId": "get_list_ai_fields_route", "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ai_fields": { "items": { "$ref": "#/components/schemas/AiField" }, "title": "Ai Fields", "type": "array" }, "campaign_id": { "title": "Campaign Id", "type": "string" }, "count": { "default": 0, "title": "Count", "type": "integer" }, "success": { "default": true, "title": "Success", "type": "boolean" } }, "required": [ "campaign_id" ], "title": "ListAiFieldsResponse", "type": "object" } } }, "description": "", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "404": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "The campaign's AI fields: per-lead variables written before each message, used as {field_name}.", "tags": [ "Campaigns" ], "security": [ { "BearerAuth": [ "campaigns:read" ] } ], "x-required-scope": "campaigns:read" }, "post": { "description": "\nGenerating a field for each lead spends the organization's tokens when the\ncampaign sends.\n\nRequires the `campaigns:write` scope (or `*`).", "operationId": "post_create_ai_field_route", "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Request body for adding an AI field to a campaign.", "properties": { "ai_instructions": { "description": "What to write for each lead, and from what", "maxLength": 4000, "title": "Ai Instructions", "type": "string" }, "data_sources": { "anyOf": [ { "items": { "enum": [ "linkedin", "website" ], "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Where to research each lead. Defaults to both.", "title": "Data Sources" }, "fallback_value": { "description": "Used when personalisation fails, so a lead still gets a sensible message", "maxLength": 300, "title": "Fallback Value", "type": "string" }, "field_description": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "type": "null" } ], "default": null, "title": "Field Description" }, "field_name": { "description": "Used as {field_name} in messages. Letters, digits, underscores.", "maxLength": 40, "title": "Field Name", "type": "string" } }, "required": [ "field_name", "ai_instructions", "fallback_value" ], "title": "CreateAiFieldRequest", "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "ai_field": { "anyOf": [ { "$ref": "#/components/schemas/AiField" }, { "type": "null" } ], "default": null }, "message": { "title": "Message", "type": "string" }, "success": { "default": true, "title": "Success", "type": "boolean" } }, "required": [ "message" ], "title": "AiFieldResponse", "type": "object" } } }, "description": "", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "400": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "404": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "409": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "Add an AI field. A fallback is required: it is what a lead gets when personalisation fails.", "tags": [ "Campaigns" ], "security": [ { "BearerAuth": [ "campaigns:write" ] } ], "x-required-scope": "campaigns:write" } }, "/campaigns/{campaign_id}/ai-fields/{field_id}": { "patch": { "description": "Requires the `campaigns:write` scope (or `*`).", "operationId": "patch_update_ai_field_route", "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "field_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Request body for changing an AI field. Set is_active=false to stop using it.", "properties": { "ai_instructions": { "anyOf": [ { "maxLength": 4000, "type": "string" }, { "type": "null" } ], "default": null, "title": "Ai Instructions" }, "data_sources": { "anyOf": [ { "items": { "enum": [ "linkedin", "website" ], "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Data Sources" }, "fallback_value": { "anyOf": [ { "maxLength": 300, "type": "string" }, { "type": "null" } ], "default": null, "title": "Fallback Value" }, "field_description": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "type": "null" } ], "default": null, "title": "Field Description" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Is Active" } }, "title": "UpdateAiFieldRequest", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ai_field": { "anyOf": [ { "$ref": "#/components/schemas/AiField" }, { "type": "null" } ], "default": null }, "message": { "title": "Message", "type": "string" }, "success": { "default": true, "title": "Success", "type": "boolean" } }, "required": [ "message" ], "title": "AiFieldResponse", "type": "object" } } }, "description": "", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "400": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "404": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "Change an AI field's instructions, fallback or sources, or set is_active=false to stop using it.", "tags": [ "Campaigns" ], "security": [ { "BearerAuth": [ "campaigns:write" ] } ], "x-required-scope": "campaigns:write" } }, "/campaigns/{campaign_id}/analysis": { "get": { "description": "breakdown, per-channel email/LinkedIn stats and a per-A/B-arm breakdown.\nAggregate counts only -- no daily timeline and no individual replies.\n\nOptional query params: date_filter (a relative window such as '7d'/'30d'/'90d',\nor an ISO-8601 timestamp, counted from then onwards) and variation\n(a|b|unassigned|all). Both return 400 if unparseable.\n\nRequires the `campaigns:read` scope (or `*`).", "operationId": "get_campaign_analysis_route", "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Relative window ('7d', '30d', '90d') or an ISO-8601 timestamp to count from", "in": "query", "name": "date_filter", "schema": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "default": null, "examples": [ "30d" ], "title": "Date Filter" } }, { "description": "A/B arm to report on: 'a', 'b', 'unassigned' or 'all' (default)", "in": "query", "name": "variation", "schema": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "default": null, "enum": [ "a", "b", "unassigned", "all" ], "examples": [ "a" ], "title": "Variation" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Response for campaign analytics.", "properties": { "analysis": { "anyOf": [ { "$ref": "#/components/schemas/CampaignAnalysis" }, { "type": "null" } ], "default": null }, "campaign_id": { "title": "Campaign Id", "type": "string" }, "success": { "default": true, "title": "Success", "type": "boolean" } }, "required": [ "campaign_id" ], "title": "CampaignAnalysisResponse", "type": "object" } } }, "description": "Response for campaign analytics.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "400": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "404": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "Campaign analytics: lead states, funnel counts and rates, reply sentiment", "tags": [ "Campaigns" ], "security": [ { "BearerAuth": [ "campaigns:read" ] } ], "x-required-scope": "campaigns:read" } }, "/campaigns/{campaign_id}/bookings": { "get": { "description": "\nCalendar bookings (with time, status and the matched lead) plus leads the\nreply agent or a person confirmed as booked, which have no calendar event\nand so no time.\n\nRequires the `campaigns:read` scope (or `*`).", "operationId": "get_campaign_bookings_route", "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "ISO timestamp; only bookings made at or after it", "in": "query", "name": "since", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Since" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Meetings booked from the campaign: calendar bookings, and leads confirmed booked without a calendar event.", "properties": { "bookings": { "items": { "additionalProperties": true, "type": "object" }, "title": "Bookings", "type": "array" }, "campaign_id": { "title": "Campaign Id", "type": "string" }, "count": { "default": 0, "title": "Count", "type": "integer" }, "success": { "default": true, "title": "Success", "type": "boolean" } }, "required": [ "campaign_id" ], "title": "CampaignBookingsResponse", "type": "object" } } }, "description": "Meetings booked from the campaign: calendar bookings, and leads confirmed booked without a calendar event.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "404": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "Meetings booked from the campaign, newest first.", "tags": [ "Campaigns" ], "security": [ { "BearerAuth": [ "campaigns:read" ] } ], "x-required-scope": "campaigns:read" } }, "/campaigns/{campaign_id}/daily-stats": { "get": { "description": "and acceptances, replies by sentiment, leads first contacted / replied /\npositive, and meetings booked, one row per UTC day.\n\nDays with no activity are omitted rather than zero-filled. The rollup is\nrefreshed hourly, so today's row is flagged partial.\n\nOptional query params: from and to (YYYY-MM-DD, or an ISO-8601 datetime\nwhose UTC date is used; to defaults to today and from to 30 days before\nit; at most 400 days, from not after to, else 400 INVALID_WINDOW) and\ngroup_by (none|sender|variation, default none; else 400 INVALID_GROUP_BY).\n\nRequires the `campaigns:read` scope (or `*`).", "operationId": "get_campaign_daily_stats_route", "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "First day (YYYY-MM-DD, or an ISO-8601 datetime whose UTC date is used). Default: 30 days before `to`", "in": "query", "name": "from", "schema": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "default": null, "examples": [ "2026-09-01" ], "title": "From" } }, { "description": "Last day, inclusive (YYYY-MM-DD, or an ISO-8601 datetime whose UTC date is used). Default: today, UTC", "in": "query", "name": "to", "schema": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "default": null, "examples": [ "2026-09-30" ], "title": "To" } }, { "description": "'none' (default): one row per day. 'sender': one row per day and sender. 'variation': one row per day and A/B arm", "in": "query", "name": "group_by", "schema": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "default": null, "enum": [ "none", "sender", "variation" ], "examples": [ "sender" ], "title": "Group By" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Daily activity and outcome counts for one campaign, summed per day (and optionally per sender or A/B arm). Days with no activity are omitted.", "properties": { "campaign_id": { "title": "Campaign Id", "type": "string" }, "count": { "default": 0, "title": "Count", "type": "integer" }, "days": { "items": { "$ref": "#/components/schemas/DailyStatsDay" }, "title": "Days", "type": "array" }, "group_by": { "default": "none", "description": "The grouping applied", "enum": [ "none", "sender", "variation" ], "title": "Group By", "type": "string" }, "success": { "default": true, "title": "Success", "type": "boolean" }, "window": { "$ref": "#/components/schemas/DailyStatsWindow" } }, "required": [ "campaign_id", "window" ], "title": "CampaignDailyStatsResponse", "type": "object" } } }, "description": "Daily activity and outcome counts for one campaign, summed per day (and optionally per sender or A/B arm). Days with no activity are omitted.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "400": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "404": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "Daily activity and outcome counts: sends, opens, connection requests", "tags": [ "Campaigns" ], "security": [ { "BearerAuth": [ "campaigns:read" ] } ], "x-required-scope": "campaigns:read" } }, "/campaigns/{campaign_id}/personalization-quality": { "get": { "description": "runs by outcome (success, fallback, generic, held, error) and how often\nthe model reported too little data to write it.\n\nheld_rate_pct over 30 means the field is mostly not producing usable\ncopy; insufficient_data_rate_pct over 60 means the data to write it is\nnot there.\n\nOptional query param: days (1-365, default 14), counted back from now.\nOut of range returns 400.\n\nRequires the `campaigns:read` scope (or `*`).", "operationId": "get_campaign_personalization_quality_route", "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "How many days back to count, from now", "in": "query", "name": "days", "schema": { "default": 14, "examples": [ 14 ], "maximum": 365, "minimum": 1, "title": "Days", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "How each of the campaign's AI personalization fields has been resolving at send time.", "properties": { "campaign_id": { "title": "Campaign Id", "type": "string" }, "days": { "title": "Days", "type": "integer" }, "fields": { "items": { "$ref": "#/components/schemas/PersonalizationField" }, "title": "Fields", "type": "array" }, "since": { "description": "Start of the window (ISO-8601)", "title": "Since", "type": "string" }, "success": { "default": true, "title": "Success", "type": "boolean" }, "total_runs": { "default": 0, "title": "Total Runs", "type": "integer" } }, "required": [ "campaign_id", "days", "since" ], "title": "CampaignPersonalizationQualityResponse", "type": "object" } } }, "description": "How each of the campaign's AI personalization fields has been resolving at send time.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "400": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "404": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "How each AI personalization field has been resolving at send time:", "tags": [ "Campaigns" ], "security": [ { "BearerAuth": [ "campaigns:read" ] } ], "x-required-scope": "campaigns:read" } }, "/campaigns/{campaign_id}/preflight": { "get": { "description": "\nThe same verdict PATCH is_active=true enforces: sequence and step content,\nvariables and lead data coverage, assigned senders and whether they are\nconnected, sender email authentication, account conflicts and limits,\nenrolled leads, and the subscription. Useful on a live campaign too: a\nfailing check there says why it has stopped sending.\n\nRequires the `campaigns:read` scope (or `*`).", "operationId": "get_campaign_preflight_route", "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "The activation readiness verdict for a campaign, without activating it.", "properties": { "blocking_count": { "default": 0, "title": "Blocking Count", "type": "integer" }, "campaign_id": { "title": "Campaign Id", "type": "string" }, "checks": { "description": "Every check: {id, label, status: pass|warn|fail, detail, tab, route}", "items": { "additionalProperties": true, "type": "object" }, "title": "Checks", "type": "array" }, "issues": { "description": "Machine-readable problems: {code, severity, message, fix}", "items": { "additionalProperties": true, "type": "object" }, "title": "Issues", "type": "array" }, "ok": { "description": "True when nothing blocks activation", "title": "Ok", "type": "boolean" }, "success": { "default": true, "title": "Success", "type": "boolean" }, "warning_count": { "default": 0, "title": "Warning Count", "type": "integer" } }, "required": [ "campaign_id", "ok" ], "title": "CampaignPreflightResponse", "type": "object" } } }, "description": "The activation readiness verdict for a campaign, without activating it.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "404": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "The activation readiness checks for a campaign, without activating it.", "tags": [ "Campaigns" ], "security": [ { "BearerAuth": [ "campaigns:read" ] } ], "x-required-scope": "campaigns:read" } }, "/campaigns/{campaign_id}/preview": { "post": { "description": "\nAI fields are shown at their fallback value -- the worst case -- so no\ntokens are spent. Each step reports its length, whether a connection note\nis over LinkedIn's 300 characters, and any variable the sender could not fill.\n\nRequires the `campaigns:read` scope (or `*`).", "operationId": "post_preview_campaign_route", "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Request body for rendering a campaign's messages for real leads.", "properties": { "lead_ids": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 10, "type": "array" }, { "type": "null" } ], "default": null, "description": "Leads in the campaign; defaults to the first few", "title": "Lead Ids" }, "limit": { "default": 3, "maximum": 10, "minimum": 1, "title": "Limit", "type": "integer" } }, "title": "PreviewRequest", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Each step rendered for each lead, with every AI field at its fallback (the worst case).", "properties": { "ai_fields_at_fallback": { "items": { "type": "string" }, "title": "Ai Fields At Fallback", "type": "array" }, "campaign_id": { "title": "Campaign Id", "type": "string" }, "previews": { "items": { "additionalProperties": true, "type": "object" }, "title": "Previews", "type": "array" }, "success": { "default": true, "title": "Success", "type": "boolean" } }, "required": [ "campaign_id" ], "title": "CampaignPreviewResponse", "type": "object" } } }, "description": "Each step rendered for each lead, with every AI field at its fallback (the worst case).", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "400": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "404": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "Render variation A for a few real leads in the campaign, as the sender would.", "tags": [ "Campaigns" ], "security": [ { "BearerAuth": [ "campaigns:read" ] } ], "x-required-scope": "campaigns:read" } }, "/campaigns/{campaign_id}/queue": { "get": { "description": "sequence leads, first-touch daily capacity, active sender count, the most\nrecent lead-database refill, and days_of_runway (backlog / daily capacity).\n\nRequires the `campaigns:read` scope (or `*`).", "operationId": "get_campaign_queue_route", "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Queue depth and runway for a campaign.\n\nRead `queue`. The same fields are also repeated at the top level;\nthose top-level copies are deprecated.", "properties": { "active_senders": { "default": 0, "title": "Active Senders", "type": "integer" }, "backlog": { "default": 0, "description": "Sequence leads not yet started (is_active=false, completed=false)", "title": "Backlog", "type": "integer" }, "campaign_id": { "title": "Campaign Id", "type": "string" }, "capacity_source": { "default": "none", "enum": [ "campaign", "org", "none" ], "title": "Capacity Source", "type": "string" }, "completed": { "default": 0, "title": "Completed", "type": "integer" }, "daily_capacity": { "default": 0, "description": "Sum of first-touch daily limits (connection_request + email)", "title": "Daily Capacity", "type": "integer" }, "days_of_runway": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "backlog / daily_capacity; null when capacity or senders are zero", "title": "Days Of Runway" }, "enabled_accounts": { "items": { "type": "string" }, "title": "Enabled Accounts", "type": "array" }, "has_filters": { "default": false, "description": "Whether lead_database_filters is set (required for auto-refill)", "title": "Has Filters", "type": "boolean" }, "in_progress": { "default": 0, "description": "Sequence leads mid-sequence", "title": "In Progress", "type": "integer" }, "is_active": { "default": false, "title": "Is Active", "type": "boolean" }, "last_refill": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "The most recent lead-refill job for the campaign (status, counts, timestamps), or null if none has run", "title": "Last Refill" }, "limits": { "additionalProperties": true, "description": "Per-platform {daily_limit, current_usage, reset_date}", "title": "Limits", "type": "object" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "queue": { "$ref": "#/components/schemas/CampaignQueue", "description": "The queue report. Prefer this over the repeated top-level fields." }, "refill_policy": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Refill Policy" }, "success": { "default": true, "title": "Success", "type": "boolean" }, "total": { "default": 0, "title": "Total", "type": "integer" }, "warnings": { "items": { "type": "string" }, "title": "Warnings", "type": "array" } }, "required": [ "campaign_id", "queue" ], "title": "CampaignQueueResponse", "type": "object" } } }, "description": "Queue depth and runway for a campaign.\n\nRead `queue`. The same fields are also repeated at the top level;\nthose top-level copies are deprecated.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "404": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "Queue depth and runway: not-started backlog, in-progress and completed", "tags": [ "Campaigns" ], "security": [ { "BearerAuth": [ "campaigns:read" ] } ], "x-required-scope": "campaigns:read" } }, "/campaigns/{campaign_id}/responder": { "get": { "description": "Requires the `campaigns:read` scope (or `*`).", "operationId": "get_get_responder_route", "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "campaign_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Campaign Id" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Message" }, "responder": { "anyOf": [ { "$ref": "#/components/schemas/ResponderConfig" }, { "type": "null" } ], "default": null }, "success": { "default": true, "title": "Success", "type": "boolean" } }, "title": "ResponderResponse", "type": "object" } } }, "description": "", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "404": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "The campaign's reply agent: whether it answers, where it sends interested prospects, what it may share.", "tags": [ "Campaigns" ], "security": [ { "BearerAuth": [ "campaigns:read" ] } ], "x-required-scope": "campaigns:read" }, "patch": { "description": "\nis_enabled here also sets the campaign's responder_enabled flag, so the two\nnever disagree. Creating a config makes the current agent, answering on\nits own.\n\nRequires the `campaigns:write` scope (or `*`).", "operationId": "patch_update_responder_route", "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Request body for the campaign's reply agent. Fields left out are unchanged.", "properties": { "agent_name": { "anyOf": [ { "maxLength": 100, "type": "string" }, { "type": "null" } ], "default": null, "title": "Agent Name" }, "assets": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponderAsset" }, "maxItems": 10, "type": "array" }, { "type": "null" } ], "default": null, "description": "Links the agent may share, e.g. a walkthrough video", "title": "Assets" }, "campaign_description": { "anyOf": [ { "maxLength": 8000, "type": "string" }, { "type": "null" } ], "default": null, "title": "Campaign Description" }, "company_name": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "default": null, "title": "Company Name" }, "custom_instructions": { "anyOf": [ { "maxLength": 8000, "type": "string" }, { "type": "null" } ], "default": null, "title": "Custom Instructions" }, "goal_link": { "anyOf": [ { "maxLength": 2000, "type": "string" }, { "type": "null" } ], "default": null, "description": "Where the agent sends an interested prospect, e.g. a booking page", "title": "Goal Link" }, "is_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Answer replies automatically", "title": "Is Enabled" }, "tone": { "anyOf": [ { "enum": [ "friendly", "direct", "formal" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Tone" } }, "title": "UpdateResponderRequest", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "campaign_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Campaign Id" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Message" }, "responder": { "anyOf": [ { "$ref": "#/components/schemas/ResponderConfig" }, { "type": "null" } ], "default": null }, "success": { "default": true, "title": "Success", "type": "boolean" } }, "title": "ResponderResponse", "type": "object" } } }, "description": "", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "400": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "404": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "Configure the reply agent: on/off, goal link, assets it may share, and instructions.", "tags": [ "Campaigns" ], "security": [ { "BearerAuth": [ "campaigns:write" ] } ], "x-required-scope": "campaigns:write" } }, "/campaigns/{campaign_id}/senders": { "put": { "description": "\nEach account must belong to this organization, be connected, and not be\nsending for another active campaign (409 ACCOUNT_NOT_CONNECTED /\nACCOUNT_IN_USE, with the accounts named in `details`).\n\nRequires the `campaigns:write` scope (or `*`).", "operationId": "put_assign_senders_route", "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Request body for replacing a campaign's sender accounts.", "properties": { "account_ids": { "description": "Connected account ids (the `id` from GET /v1/accounts). Replaces the current set. Each must be connected and not sending for another active campaign.", "items": { "type": "string" }, "maxItems": 20, "minItems": 1, "title": "Account Ids", "type": "array" } }, "required": [ "account_ids" ], "title": "AssignSendersRequest", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "campaign_id": { "title": "Campaign Id", "type": "string" }, "enabled_accounts": { "items": { "additionalProperties": true, "type": "object" }, "title": "Enabled Accounts", "type": "array" }, "message": { "title": "Message", "type": "string" }, "success": { "default": true, "title": "Success", "type": "boolean" } }, "required": [ "message", "campaign_id" ], "title": "AssignSendersResponse", "type": "object" } } }, "description": "", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "400": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "404": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "409": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "Set which sender accounts send for a campaign (replaces the current set).", "tags": [ "Campaigns" ], "security": [ { "BearerAuth": [ "campaigns:write" ] } ], "x-required-scope": "campaigns:write" } }, "/campaigns/{campaign_id}/senders/breakdown": { "get": { "description": "sent, acceptances, and the leads each sender contacted, got replies from\nand got positive replies from, with rates.\n\nSenders that have since been disconnected still appear, with is_active\nfalse and no account_id.\n\nOptional query params: date_filter (a relative window such as '7d'/'30d'/'90d',\nor an ISO-8601 timestamp, counted from then onwards) and variation\n(a|b|unassigned|all). Both return 400 if unparseable.\n\nRequires the `campaigns:read` scope (or `*`).", "operationId": "get_campaign_sender_breakdown_route", "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Relative window ('7d', '30d', '90d') or an ISO-8601 timestamp to count from", "in": "query", "name": "date_filter", "schema": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "default": null, "examples": [ "30d" ], "title": "Date Filter" } }, { "description": "A/B arm to report on: 'a', 'b', 'unassigned' or 'all' (default)", "in": "query", "name": "variation", "schema": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "default": null, "enum": [ "a", "b", "unassigned", "all" ], "examples": [ "a" ], "title": "Variation" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Per-sender outbound and reply counts for one campaign.", "properties": { "campaign_id": { "title": "Campaign Id", "type": "string" }, "count": { "default": 0, "title": "Count", "type": "integer" }, "senders": { "items": { "$ref": "#/components/schemas/SenderBreakdownRow" }, "title": "Senders", "type": "array" }, "success": { "default": true, "title": "Success", "type": "boolean" }, "variation": { "default": "all", "description": "The A/B arm the report covers", "title": "Variation", "type": "string" }, "window_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Start of the window (ISO-8601); null = all time", "title": "Window From" } }, "required": [ "campaign_id" ], "title": "CampaignSenderBreakdownResponse", "type": "object" } } }, "description": "Per-sender outbound and reply counts for one campaign.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "400": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "404": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "Per-sender outbound and reply counts: messages and connection requests", "tags": [ "Campaigns" ], "security": [ { "BearerAuth": [ "campaigns:read" ] } ], "x-required-scope": "campaigns:read" } }, "/campaigns/{campaign_id}/sequence": { "put": { "description": "\nSend `expected_updated_at` to write only if the campaign has not changed\nsince you read it (409 SEQUENCE_MODIFIED otherwise).\n\nRequires the `campaigns:write` scope (or `*`).", "operationId": "put_replace_sequence_route", "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Request body for replacing a campaign's whole sequence.", "properties": { "expected_updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The campaign's updated_at as you last read it. If it has changed since, nothing is written and the answer is 409 SEQUENCE_MODIFIED.", "title": "Expected Updated At" }, "sequence": { "additionalProperties": true, "description": "Full sequence object with variation_a (and optionally variation_b) step arrays", "title": "Sequence", "type": "object" } }, "required": [ "sequence" ], "title": "UpdateSequenceRequest", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Response for sequence writes.", "properties": { "campaign_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Campaign Id" }, "message": { "title": "Message", "type": "string" }, "success": { "default": true, "title": "Success", "type": "boolean" } }, "required": [ "message" ], "title": "UpdateSequenceResponse", "type": "object" } } }, "description": "Response for sequence writes.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "400": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "404": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "409": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "Replace a campaign's whole sequence (validated before saving).", "tags": [ "Campaigns" ], "security": [ { "BearerAuth": [ "campaigns:write" ] } ], "x-required-scope": "campaigns:write" } }, "/campaigns/{campaign_id}/sequence/steps/{step_id}": { "patch": { "description": "Requires the `campaigns:write` scope (or `*`).", "operationId": "patch_update_sequence_step_route", "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "step_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Request body for patching one sequence step by id.", "properties": { "updates": { "additionalProperties": true, "description": "Fields to change on the step. Only message, subject, content and delay may be patched; id, type and branches are structural and require PUT .../sequence.", "examples": [ { "delay": 3, "subject": "Quick question, {first_name}" } ], "title": "Updates", "type": "object" } }, "required": [ "updates" ], "title": "UpdateSequenceStepRequest", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Response for sequence writes.", "properties": { "campaign_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Campaign Id" }, "message": { "title": "Message", "type": "string" }, "success": { "default": true, "title": "Success", "type": "boolean" } }, "required": [ "message" ], "title": "UpdateSequenceResponse", "type": "object" } } }, "description": "Response for sequence writes.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "400": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "404": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "409": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "Patch a single sequence step by id (searches conditional branches; whole sequence re-validated).", "tags": [ "Campaigns" ], "security": [ { "BearerAuth": [ "campaigns:write" ] } ], "x-required-scope": "campaigns:write" } }, "/campaigns/{campaign_id}/step-funnel": { "get": { "description": "each step of the sequence, annotated with the step at each position.\n\nPositions follow the sequence's own numbering; a connection check splits\nlater steps into yes/no lanes. Replies are credited to the last message\nstep before them. waiting is current state and ignores the window.\n\nOptional query params: date_filter (a relative window such as '7d'/'30d'/'90d',\nor an ISO-8601 timestamp, counted from then onwards) and variation\n(a|b|unassigned|all). Both return 400 if unparseable.\n\nRequires the `campaigns:read` scope (or `*`).", "operationId": "get_campaign_step_funnel_route", "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Relative window ('7d', '30d', '90d') or an ISO-8601 timestamp to count from", "in": "query", "name": "date_filter", "schema": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "default": null, "examples": [ "30d" ], "title": "Date Filter" } }, { "description": "A/B arm to report on: 'a', 'b', 'unassigned' or 'all' (default)", "in": "query", "name": "variation", "schema": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "default": null, "enum": [ "a", "b", "unassigned", "all" ], "examples": [ "a" ], "title": "Variation" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Per-step funnel for one campaign: how many leads reached, are waiting at, and replied to each step.", "properties": { "campaign_id": { "title": "Campaign Id", "type": "string" }, "hidden_main_steps": { "default": 0, "description": "Main-lane message steps sharing a position with a branch, and so not shown on their own row", "title": "Hidden Main Steps", "type": "integer" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "How to read the numbers", "title": "Note" }, "steps": { "items": { "$ref": "#/components/schemas/StepFunnelStep" }, "title": "Steps", "type": "array" }, "success": { "default": true, "title": "Success", "type": "boolean" }, "unattributed_outbound": { "default": 0, "description": "Sends that could not be matched to a step", "title": "Unattributed Outbound", "type": "integer" }, "unattributed_replies": { "default": 0, "description": "Replies that could not be matched to a step", "title": "Unattributed Replies", "type": "integer" }, "variation": { "default": "all", "description": "The A/B arm the report covers", "title": "Variation", "type": "string" }, "window_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Start of the window (ISO-8601); null = all time", "title": "Window From" } }, "required": [ "campaign_id" ], "title": "CampaignStepFunnelResponse", "type": "object" } } }, "description": "Per-step funnel for one campaign: how many leads reached, are waiting at, and replied to each step.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "400": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "404": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "Per-step funnel: how many leads reached, are waiting at, and replied to", "tags": [ "Campaigns" ], "security": [ { "BearerAuth": [ "campaigns:read" ] } ], "x-required-scope": "campaigns:read" } }, "/campaigns/{campaign_id}/webhook/activate": { "post": { "deprecated": true, "description": "\nRegisters a webhook URL that will receive events when leads respond\nto campaign outreach. Multiple webhooks can be registered per campaign,\nand all active webhooks will receive events simultaneously.\n\nRequires the `campaigns:write` scope (or `*`).", "operationId": "post_activate_campaign_webhook", "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Request body for activating a campaign response webhook.", "properties": { "replace": { "default": false, "description": "A campaign has one response webhook. When a different URL already holds it, the request is refused with WEBHOOK_SLOT_TAKEN unless this is true, in which case that webhook is repointed at webhook_url and the previous receiver stops getting this campaign's responses.", "title": "Replace", "type": "boolean" }, "secret": { "anyOf": [ { "minLength": 16, "type": "string" }, { "type": "null" } ], "default": null, "description": "Caller-supplied HMAC signing secret so the receiver holds the same key; generated server-side when omitted (and then unrecoverable by the receiver)", "title": "Secret" }, "webhook_url": { "description": "URL to receive webhook events", "examples": [ "https://api.example.com/webhooks/victoria" ], "title": "Webhook Url", "type": "string" } }, "required": [ "webhook_url" ], "title": "ActivateWebhookRequest", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Response for successful webhook activation.", "properties": { "created": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "True when a new webhook was created, false when an existing disabled one was re-enabled", "title": "Created" }, "message": { "default": "Webhook activated successfully", "title": "Message", "type": "string" }, "replaced": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "True when an existing webhook for a different URL was repointed (replace=true)", "title": "Replaced" }, "secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Present only when the signing secret was generated server-side, and only in this response: store it now, it cannot be retrieved again. Absent when you supplied your own.", "title": "Secret" }, "success": { "default": true, "title": "Success", "type": "boolean" }, "webhook_id": { "description": "ID of the webhook record", "title": "Webhook Id", "type": "string" } }, "required": [ "webhook_id" ], "title": "ActivateWebhookResponse", "type": "object" } } }, "description": "Response for successful webhook activation.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Link": { "$ref": "#/components/headers/Link" } } }, "400": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Link": { "$ref": "#/components/headers/Link" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Link": { "$ref": "#/components/headers/Link" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Link": { "$ref": "#/components/headers/Link" } } }, "404": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Link": { "$ref": "#/components/headers/Link" } } }, "409": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Link": { "$ref": "#/components/headers/Link" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Link": { "$ref": "#/components/headers/Link" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Link": { "$ref": "#/components/headers/Link" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Link": { "$ref": "#/components/headers/Link" } } } }, "summary": "Create a new webhook subscription for a campaign.", "tags": [ "Campaigns" ], "security": [ { "BearerAuth": [ "campaigns:write" ] } ], "x-required-scope": "campaigns:write" } }, "/campaigns/{campaign_id}/webhook/deactivate": { "post": { "deprecated": true, "description": "\nDisables the webhook so it will no longer receive events.\nThe webhook configuration is retained and can be re-activated later.\nRequires the webhook_id returned from the activate endpoint.\n\nRequires the `campaigns:write` scope (or `*`).", "operationId": "post_deactivate_campaign_webhook", "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Request body for deactivating a specific webhook subscription.", "properties": { "webhook_id": { "description": "ID of the webhook to deactivate", "examples": [ "550e8400-e29b-41d4-a716-446655440000" ], "format": "uuid", "title": "Webhook Id", "type": "string" } }, "required": [ "webhook_id" ], "title": "DeactivateWebhookRequest", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Response for successful webhook deactivation.", "properties": { "message": { "default": "Webhook deactivated successfully", "title": "Message", "type": "string" }, "success": { "default": true, "title": "Success", "type": "boolean" } }, "title": "DeactivateWebhookResponse", "type": "object" } } }, "description": "Response for successful webhook deactivation.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Link": { "$ref": "#/components/headers/Link" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Link": { "$ref": "#/components/headers/Link" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Link": { "$ref": "#/components/headers/Link" } } }, "404": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Link": { "$ref": "#/components/headers/Link" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Link": { "$ref": "#/components/headers/Link" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Link": { "$ref": "#/components/headers/Link" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Link": { "$ref": "#/components/headers/Link" } } } }, "summary": "Deactivate a specific webhook subscription for a campaign.", "tags": [ "Campaigns" ], "security": [ { "BearerAuth": [ "campaigns:write" ] } ], "x-required-scope": "campaigns:write" } }, "/campaigns/{campaign_id}/webhooks": { "get": { "description": "\nReturns all webhook subscriptions registered for the campaign,\nincluding both active and disabled webhooks.\n\nRequires the `campaigns:read` scope (or `*`).", "operationId": "get_list_campaign_webhooks", "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Maximum rows to return", "in": "query", "name": "limit", "schema": { "default": 100, "maximum": 500, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "Rows to skip before returning results", "in": "query", "name": "offset", "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Response for listing webhook subscriptions.", "properties": { "count": { "description": "Webhooks in this page. Deprecated: use `total`", "title": "Count", "type": "integer" }, "has_more": { "description": "Whether a further page exists", "title": "Has More", "type": "boolean" }, "limit": { "description": "Page size that was applied", "title": "Limit", "type": "integer" }, "offset": { "description": "Rows skipped before this page", "title": "Offset", "type": "integer" }, "success": { "default": true, "title": "Success", "type": "boolean" }, "total": { "description": "Total rows matching the query, across all pages", "title": "Total", "type": "integer" }, "webhooks": { "description": "List of webhook subscriptions for the campaign", "items": { "$ref": "#/components/schemas/WebhookRecord" }, "title": "Webhooks", "type": "array" } }, "required": [ "total", "limit", "offset", "has_more", "webhooks", "count" ], "title": "ListWebhooksResponse", "type": "object" } } }, "description": "Response for listing webhook subscriptions.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "404": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "List all webhook subscriptions for a campaign.", "tags": [ "Campaigns" ], "security": [ { "BearerAuth": [ "campaigns:read" ] } ], "x-required-scope": "campaigns:read" }, "post": { "description": "\n201 when a webhook is created, 200 when a previously disabled one for the\nsame URL is re-enabled or, with `replace`, when the campaign's existing\nwebhook is repointed. 409 if that URL is already active, or if a different\nURL holds the campaign's one webhook slot and `replace` is not set.\n\nSupply `secret` so both sides hold the same signing key, or omit it and one\nis generated and shown once in the response. Deliveries carry\n`X-Signature-256`, an HMAC-SHA256 over the exact bytes sent.\n\nReplaces `POST /campaigns/{campaign_id}/webhook/activate`.\n\nRequires the `campaigns:write` scope (or `*`).", "operationId": "post_create_campaign_webhook", "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Request body for activating a campaign response webhook.", "properties": { "replace": { "default": false, "description": "A campaign has one response webhook. When a different URL already holds it, the request is refused with WEBHOOK_SLOT_TAKEN unless this is true, in which case that webhook is repointed at webhook_url and the previous receiver stops getting this campaign's responses.", "title": "Replace", "type": "boolean" }, "secret": { "anyOf": [ { "minLength": 16, "type": "string" }, { "type": "null" } ], "default": null, "description": "Caller-supplied HMAC signing secret so the receiver holds the same key; generated server-side when omitted (and then unrecoverable by the receiver)", "title": "Secret" }, "webhook_url": { "description": "URL to receive webhook events", "examples": [ "https://api.example.com/webhooks/victoria" ], "title": "Webhook Url", "type": "string" } }, "required": [ "webhook_url" ], "title": "ActivateWebhookRequest", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Response for successful webhook activation.", "properties": { "created": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "True when a new webhook was created, false when an existing disabled one was re-enabled", "title": "Created" }, "message": { "default": "Webhook activated successfully", "title": "Message", "type": "string" }, "replaced": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "True when an existing webhook for a different URL was repointed (replace=true)", "title": "Replaced" }, "secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Present only when the signing secret was generated server-side, and only in this response: store it now, it cannot be retrieved again. Absent when you supplied your own.", "title": "Secret" }, "success": { "default": true, "title": "Success", "type": "boolean" }, "webhook_id": { "description": "ID of the webhook record", "title": "Webhook Id", "type": "string" } }, "required": [ "webhook_id" ], "title": "ActivateWebhookResponse", "type": "object" } } }, "description": "Response for successful webhook activation.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "201": { "content": { "application/json": { "schema": { "description": "Response for successful webhook activation.", "properties": { "created": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "True when a new webhook was created, false when an existing disabled one was re-enabled", "title": "Created" }, "message": { "default": "Webhook activated successfully", "title": "Message", "type": "string" }, "replaced": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "True when an existing webhook for a different URL was repointed (replace=true)", "title": "Replaced" }, "secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Present only when the signing secret was generated server-side, and only in this response: store it now, it cannot be retrieved again. Absent when you supplied your own.", "title": "Secret" }, "success": { "default": true, "title": "Success", "type": "boolean" }, "webhook_id": { "description": "ID of the webhook record", "title": "Webhook Id", "type": "string" } }, "required": [ "webhook_id" ], "title": "ActivateWebhookResponse", "type": "object" } } }, "description": "Response for successful webhook activation.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "400": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "404": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "409": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "Register a webhook to receive this campaign's prospect responses.", "tags": [ "Campaigns" ], "security": [ { "BearerAuth": [ "campaigns:write" ] } ], "x-required-scope": "campaigns:write" } }, "/campaigns/{campaign_id}/webhooks/{webhook_id}": { "delete": { "description": "\nThe subscription is disabled rather than destroyed, so registering the same\nURL again re-enables it -- along with its signing secret -- instead of\ncreating a duplicate.\n\nReplaces `POST /campaigns/{campaign_id}/webhook/deactivate`.\n\nRequires the `campaigns:write` scope (or `*`).", "operationId": "delete_delete_campaign_webhook", "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "webhook_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Response for successful webhook deactivation.", "properties": { "message": { "default": "Webhook deactivated successfully", "title": "Message", "type": "string" }, "success": { "default": true, "title": "Success", "type": "boolean" } }, "title": "DeactivateWebhookResponse", "type": "object" } } }, "description": "Response for successful webhook deactivation.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "404": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "Stop delivering this campaign's responses to a webhook.", "tags": [ "Campaigns" ], "security": [ { "BearerAuth": [ "campaigns:write" ] } ], "x-required-scope": "campaigns:write" } }, "/campaigns/{campaign_id}/webhooks/{webhook_id}/secret": { "post": { "description": "\nDeliveries carry an `X-Signature-256: sha256=` header, an HMAC-SHA256\nover the exact bytes sent, computed with this secret. Verify it by\nrecomputing over the raw request body before parsing it.\n\nSupply your own `secret` so both sides hold the same value, or omit it and\none is generated. A generated secret is shown in this response and nowhere\nelse -- store it now. Use this to adopt signing on a webhook created before\nsecrets were returned, or to rotate one you believe is compromised.\n\nRequires the `campaigns:write` scope (or `*`).", "operationId": "post_rotate_campaign_webhook_secret", "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "webhook_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Request body for setting or replacing a webhook's signing secret.", "properties": { "secret": { "anyOf": [ { "minLength": 16, "type": "string" }, { "type": "null" } ], "default": null, "description": "Your own signing key, so both sides hold the same value. Omit it and one is generated and returned once.", "title": "Secret" } }, "title": "RotateWebhookSecretRequest", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Response for a signing-secret rotation.", "properties": { "message": { "default": "Webhook signing secret rotated", "title": "Message", "type": "string" }, "secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Present only when the secret was generated server-side, and only in this response: store it now, it cannot be retrieved again. Absent when you supplied your own.", "title": "Secret" }, "success": { "default": true, "title": "Success", "type": "boolean" }, "webhook_id": { "description": "ID of the webhook whose secret was rotated", "title": "Webhook Id", "type": "string" } }, "required": [ "webhook_id" ], "title": "RotateWebhookSecretResponse", "type": "object" } } }, "description": "Response for a signing-secret rotation.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "400": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "404": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "Set or replace a webhook's signing secret.", "tags": [ "Campaigns" ], "security": [ { "BearerAuth": [ "campaigns:write" ] } ], "x-required-scope": "campaigns:write" } }, "/crm/deals": { "get": { "description": "\nRetrieve deals for your organization with optional filtering by\nstage, pipeline, owner, or lead.\n\nRequires the `crm:read` scope (or `*`).", "operationId": "get_list_deals", "parameters": [ { "description": "Filter by stage ID", "in": "query", "name": "stage_id", "schema": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "title": "Stage Id" } }, { "description": "Filter by owner ID", "in": "query", "name": "owner_id", "schema": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "title": "Owner Id" } }, { "description": "Filter by lead ID", "in": "query", "name": "lead_id", "schema": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "title": "Lead Id" } }, { "description": "Maximum number of deals to return", "in": "query", "name": "limit", "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "Number of deals to skip", "in": "query", "name": "offset", "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Response for getting deals.", "properties": { "count": { "description": "Deals in this page", "title": "Count", "type": "integer" }, "deals": { "description": "List of deals", "items": { "$ref": "#/components/schemas/DealWithLead" }, "title": "Deals", "type": "array" }, "has_more": { "description": "Whether a further page exists", "title": "Has More", "type": "boolean" }, "limit": { "description": "Page size that was applied", "title": "Limit", "type": "integer" }, "message": { "title": "Message", "type": "string" }, "offset": { "description": "Rows skipped before this page", "title": "Offset", "type": "integer" }, "success": { "default": true, "title": "Success", "type": "boolean" }, "total": { "description": "Total rows matching the query, across all pages", "title": "Total", "type": "integer" } }, "required": [ "total", "limit", "offset", "has_more", "message", "deals", "count" ], "title": "GetDealsResponse", "type": "object" } } }, "description": "Response for getting deals.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "400": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "Get deals with optional filters.", "tags": [ "CRM - Deals" ], "security": [ { "BearerAuth": [ "crm:read" ] } ], "x-required-scope": "crm:read" }, "post": { "description": "\nCreate a new deal (sales opportunity) in the CRM.\n\nRequires the `crm:write` scope (or `*`).", "operationId": "post_create_deal_endpoint", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Request body for creating a deal. Provide either lead_id to link an existing lead, or lead data to create a new lead automatically.", "properties": { "expected_close_date": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "Expected close date", "examples": [ "2024-03-31T00:00:00Z" ], "title": "Expected Close Date" }, "lead": { "anyOf": [ { "$ref": "#/components/schemas/CreateDealLeadData" }, { "type": "null" } ], "default": null, "description": "Inline lead data \u2014 a new lead will be created and linked to this deal. Cannot be used together with lead_id." }, "lead_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "description": "ID of an existing lead to associate with this deal", "examples": [ "a1b2c3d4-e5f6-7890-abcd-ef1234567890" ], "title": "Lead Id" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional metadata", "examples": [ { "campaign": "Q1 outreach", "source": "inbound" } ], "title": "Metadata" }, "name": { "description": "Deal name/title", "examples": [ "Acme Corp - Enterprise License" ], "title": "Name", "type": "string" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Deal notes", "examples": [ "Initial meeting scheduled for next week" ], "title": "Notes" }, "owner_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "description": "ID of the deal owner (user)", "examples": [ "f4a5b6c7-d8e9-0123-f012-456789012345" ], "title": "Owner Id" }, "probability": { "anyOf": [ { "maximum": 100, "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Win probability percentage (0-100)", "examples": [ 25 ], "title": "Probability" }, "stage_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "description": "Initial stage ID (defaults to first stage in pipeline)", "examples": [ "d2e3f4a5-b6c7-8901-def0-234567890123" ], "title": "Stage Id" }, "value": { "anyOf": [ { "minimum": 0, "type": "number" }, { "type": "null" } ], "default": null, "description": "Deal value in dollars", "examples": [ 50000.0 ], "title": "Value" } }, "required": [ "name" ], "title": "CreateDealRequest", "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "description": "Response for successful deal creation.", "properties": { "deal": { "$ref": "#/components/schemas/Deal", "description": "The created deal" }, "message": { "title": "Message", "type": "string" }, "success": { "default": true, "title": "Success", "type": "boolean" } }, "required": [ "message", "deal" ], "title": "CreateDealResponse", "type": "object" } } }, "description": "Response for successful deal creation.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Idempotent-Replay": { "$ref": "#/components/headers/Idempotent-Replay" } } }, "400": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "409": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints. Also `IDEMPOTENCY_KEY_REUSED` (the key was used with a different request) and `IDEMPOTENCY_IN_PROGRESS` (its first request is still running; carries `Retry-After`).", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "Create a new deal.", "tags": [ "CRM - Deals" ], "security": [ { "BearerAuth": [ "crm:write" ] } ], "x-required-scope": "crm:write" } }, "/crm/deals/{deal_id}": { "get": { "description": "\nRetrieve detailed information about a specific deal including\nassociated lead data and recent activities.\n\nRequires the `crm:read` scope (or `*`).", "operationId": "get_get_deal", "parameters": [ { "in": "path", "name": "deal_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Response for getting a single deal.", "properties": { "deal": { "$ref": "#/components/schemas/DealWithLead", "description": "Deal data with lead info" }, "message": { "title": "Message", "type": "string" }, "success": { "default": true, "title": "Success", "type": "boolean" } }, "required": [ "message", "deal" ], "title": "GetDealResponse", "type": "object" } } }, "description": "Response for getting a single deal.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "404": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "Get a single deal by ID.", "tags": [ "CRM - Deals" ], "security": [ { "BearerAuth": [ "crm:read" ] } ], "x-required-scope": "crm:read" }, "patch": { "description": "\nUpdate fields on an existing deal. Only provided fields will be updated.\n\nRequires the `crm:write` scope (or `*`).", "operationId": "patch_update_deal_endpoint", "parameters": [ { "in": "path", "name": "deal_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Request body for updating a deal. All fields are optional - only include fields you want to update.", "properties": { "actual_close_date": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "Actual close date (set when deal is won/lost)", "examples": [ "2024-03-15T00:00:00Z" ], "title": "Actual Close Date" }, "custom_fields": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Custom fields as key-value pairs", "examples": [ { "priority": "high" } ], "title": "Custom Fields" }, "expected_close_date": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "Expected close date", "examples": [ "2024-03-31T00:00:00Z" ], "title": "Expected Close Date" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Deal name/title", "examples": [ "Acme Corp - Enterprise License" ], "title": "Name" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Deal notes", "examples": [ "Contract under legal review" ], "title": "Notes" }, "owner_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "description": "ID of the deal owner (user)", "examples": [ "f4a5b6c7-d8e9-0123-f012-456789012345" ], "title": "Owner Id" }, "probability": { "anyOf": [ { "maximum": 100, "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Win probability percentage (0-100)", "examples": [ 75 ], "title": "Probability" }, "stage_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "description": "Move deal to a different stage", "examples": [ "d2e3f4a5-b6c7-8901-def0-234567890123" ], "title": "Stage Id" }, "value": { "anyOf": [ { "minimum": 0, "type": "number" }, { "type": "null" } ], "default": null, "description": "Deal value in dollars", "examples": [ 75000.0 ], "title": "Value" } }, "title": "UpdateDealRequest", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Response for successful deal update.", "properties": { "deal": { "$ref": "#/components/schemas/Deal", "description": "The updated deal" }, "message": { "title": "Message", "type": "string" }, "success": { "default": true, "title": "Success", "type": "boolean" } }, "required": [ "message", "deal" ], "title": "UpdateDealResponse", "type": "object" } } }, "description": "Response for successful deal update.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "400": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "404": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "Update a deal by ID.", "tags": [ "CRM - Deals" ], "security": [ { "BearerAuth": [ "crm:write" ] } ], "x-required-scope": "crm:write" } }, "/crm/pipelines": { "get": { "description": "\nRetrieve all active sales pipelines for your organization.\n\nRequires the `crm:read` scope (or `*`).", "operationId": "get_list_pipelines", "parameters": [ { "description": "Maximum rows to return", "in": "query", "name": "limit", "schema": { "default": 100, "maximum": 500, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "Rows to skip before returning results", "in": "query", "name": "offset", "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Response for getting pipelines.", "properties": { "count": { "description": "Pipelines in this page", "title": "Count", "type": "integer" }, "has_more": { "description": "Whether a further page exists", "title": "Has More", "type": "boolean" }, "limit": { "description": "Page size that was applied", "title": "Limit", "type": "integer" }, "message": { "title": "Message", "type": "string" }, "offset": { "description": "Rows skipped before this page", "title": "Offset", "type": "integer" }, "pipelines": { "description": "List of pipelines", "items": { "$ref": "#/components/schemas/Pipeline" }, "title": "Pipelines", "type": "array" }, "success": { "default": true, "title": "Success", "type": "boolean" }, "total": { "description": "Total rows matching the query, across all pages", "title": "Total", "type": "integer" } }, "required": [ "total", "limit", "offset", "has_more", "message", "pipelines", "count" ], "title": "GetPipelinesResponse", "type": "object" } } }, "description": "Response for getting pipelines.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "Get all pipelines.", "tags": [ "CRM - Pipelines" ], "security": [ { "BearerAuth": [ "crm:read" ] } ], "x-required-scope": "crm:read" } }, "/crm/pipelines/{pipeline_id}": { "get": { "description": "\nRetrieve a specific pipeline including its stages.\n\nRequires the `crm:read` scope (or `*`).", "operationId": "get_get_pipeline", "parameters": [ { "in": "path", "name": "pipeline_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Response for getting a single pipeline.", "properties": { "message": { "title": "Message", "type": "string" }, "pipeline": { "$ref": "#/components/schemas/Pipeline", "description": "Pipeline data" }, "stages": { "description": "Stages in this pipeline", "items": { "$ref": "#/components/schemas/Stage" }, "title": "Stages", "type": "array" }, "success": { "default": true, "title": "Success", "type": "boolean" } }, "required": [ "message", "pipeline" ], "title": "GetPipelineResponse", "type": "object" } } }, "description": "Response for getting a single pipeline.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "404": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "Get a pipeline by ID.", "tags": [ "CRM - Pipelines" ], "security": [ { "BearerAuth": [ "crm:read" ] } ], "x-required-scope": "crm:read" }, "patch": { "description": "\nUpdate pipeline properties. Only provided fields will be updated.\n\nRequires the `crm:write` scope (or `*`).", "operationId": "patch_update_pipeline_endpoint", "parameters": [ { "in": "path", "name": "pipeline_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Request body for updating a pipeline. All fields are optional - only include fields you want to update.", "properties": { "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this pipeline is active (inactive pipelines are hidden)", "title": "Is Active" }, "is_default": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Set as the default pipeline for new deals", "title": "Is Default" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Pipeline name", "examples": [ "Enterprise Sales" ], "title": "Name" } }, "title": "UpdatePipelineRequest", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Response for a pipeline update.", "properties": { "message": { "title": "Message", "type": "string" }, "pipeline": { "$ref": "#/components/schemas/Pipeline", "description": "The updated pipeline" }, "success": { "default": true, "title": "Success", "type": "boolean" } }, "required": [ "message", "pipeline" ], "title": "UpdatePipelineResponse", "type": "object" } } }, "description": "Response for a pipeline update.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "400": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "404": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "Update a pipeline.", "tags": [ "CRM - Pipelines" ], "security": [ { "BearerAuth": [ "crm:write" ] } ], "x-required-scope": "crm:write" } }, "/leads": { "get": { "description": "\nRetrieve leads for your organization with optional filtering by campaign,\nrevenue range, employee count, industry, title, or search term.\nSupports pagination with configurable page size (max 100 per page).\n\nRequires the `leads:read` scope (or `*`).", "operationId": "get_get_leads", "parameters": [ { "description": "Filter by campaign ID", "in": "query", "name": "campaign_id", "schema": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "title": "Campaign Id" } }, { "description": "Minimum annual revenue filter", "in": "query", "name": "min_revenue", "schema": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "title": "Min Revenue" } }, { "description": "Maximum annual revenue filter", "in": "query", "name": "max_revenue", "schema": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "title": "Max Revenue" } }, { "description": "Minimum employee count filter", "in": "query", "name": "min_employees", "schema": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "title": "Min Employees" } }, { "description": "Maximum employee count filter", "in": "query", "name": "max_employees", "schema": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "title": "Max Employees" } }, { "description": "Filter by industry (case-insensitive match)", "in": "query", "name": "industry", "schema": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "default": null, "title": "Industry" } }, { "description": "Filter by job title (case-insensitive partial match)", "in": "query", "name": "title", "schema": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "default": null, "title": "Title" } }, { "description": "Search by name, email or company (case-insensitive; up to 5 words)", "in": "query", "name": "search", "schema": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "default": null, "title": "Search" } }, { "description": "Page number (1-indexed). Prefer `offset`, which every list route supports", "in": "query", "name": "page", "schema": { "default": 1, "minimum": 1, "title": "Page", "type": "integer" } }, { "description": "Results per page (max 100)", "in": "query", "name": "limit", "schema": { "default": 20, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "Rows to skip. The portable idiom, shared with every other list route; wins over `page` when both are sent", "in": "query", "name": "offset", "schema": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "title": "Offset" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Paginated response for leads list.", "properties": { "count": { "description": "Leads in this page", "title": "Count", "type": "integer" }, "has_more": { "description": "Whether a further page exists", "title": "Has More", "type": "boolean" }, "leads": { "description": "Array of leads", "items": { "$ref": "#/components/schemas/LeadDetail" }, "title": "Leads", "type": "array" }, "limit": { "description": "Page size that was applied", "title": "Limit", "type": "integer" }, "offset": { "description": "Rows skipped before this page", "title": "Offset", "type": "integer" }, "page": { "description": "Current page number. Prefer `offset`, which every list route returns", "title": "Page", "type": "integer" }, "success": { "default": true, "title": "Success", "type": "boolean" }, "total": { "description": "Total rows matching the query, across all pages", "title": "Total", "type": "integer" } }, "required": [ "total", "limit", "offset", "has_more", "leads", "count", "page" ], "title": "GetLeadsResponse", "type": "object" } } }, "description": "Paginated response for leads list.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "400": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "Get leads with optional filters.", "tags": [ "Leads" ], "security": [ { "BearerAuth": [ "leads:read" ] } ], "x-required-scope": "leads:read" }, "post": { "description": "\nThe lead may be sent nested under `lead` or spread across the top level;\nboth are accepted. Emails are matched case-insensitively.\n\nOutcomes:\n- `201` -- the lead was created (and enrolled, when `campaign_id` was given).\n- `200` -- a lead with this email or LinkedIn URL already existed and was\n enrolled in `campaign_id`; `lead_created` is `false` and `lead` is the\n stored record.\n- `409 LEAD_ALREADY_IN_CAMPAIGN` -- it already existed and is already in\n that campaign.\n- `409 LEAD_ALREADY_EXISTS` -- it already existed and no `campaign_id` was\n given, so there was nothing to do. `details.existing_lead_id` names it.\n- `409 LEAD_SUPPRESSED` -- the contact is on your do-not-contact list;\n nothing was created or enrolled. `details.suppressed_by` is `email`,\n `domain` or `linkedin_url`.\n\nRequires the `leads:write` scope (or `*`).", "operationId": "post_create_lead", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Request body for POST /v1/leads.\n\nThe lead may be nested under `lead` or spread across the top level; both\nare accepted. `campaign_id` is optional: with it, the lead is created (or,\nif it already exists, reused) and enrolled in that campaign; without it,\nthe lead is created on its own.", "properties": { "campaign_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "description": "UUID of the campaign to enrol the lead in. Omit to create the lead without enrolling it.", "examples": [ "550e8400-e29b-41d4-a716-446655440000" ], "title": "Campaign Id" }, "custom_fields": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Custom fields for this campaign assignment (distinct from the lead's own custom_fields)", "examples": [ { "utm_source": "linkedin" } ], "title": "Custom Fields" }, "lead": { "$ref": "#/components/schemas/Lead", "description": "Lead data. May also be supplied as top-level fields." } }, "required": [ "lead" ], "title": "AddLeadRequest", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Response for POST /v1/leads: 201 when the lead was created, 200 when an\nexisting lead was enrolled.", "properties": { "campaign_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Campaign the lead was enrolled in. Also available as enrollment.campaign_id", "title": "Campaign Id" }, "enrollment": { "anyOf": [ { "$ref": "#/components/schemas/Enrollment" }, { "type": "null" } ], "default": null, "description": "Present when a campaign_id was supplied; null otherwise" }, "lead": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "The lead record as stored", "title": "Lead" }, "lead_created": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "true when this request created the lead; false when a lead with this email or LinkedIn URL already existed and was enrolled", "title": "Lead Created" }, "lead_id": { "description": "ID of the created or existing lead", "examples": [ "a1b2c3d4-e5f6-7890-abcd-ef1234567890" ], "title": "Lead Id", "type": "string" }, "message": { "examples": [ "Lead added successfully" ], "title": "Message", "type": "string" }, "sequence_lead_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ID of the campaign sequence entry. Also available as enrollment.sequence_lead_id", "title": "Sequence Lead Id" }, "success": { "default": true, "title": "Success", "type": "boolean" } }, "required": [ "message", "lead_id" ], "title": "AddLeadResponse", "type": "object" } } }, "description": "Response for POST /v1/leads: 201 when the lead was created, 200 when an\nexisting lead was enrolled.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Idempotent-Replay": { "$ref": "#/components/headers/Idempotent-Replay" } } }, "201": { "content": { "application/json": { "schema": { "description": "Response for POST /v1/leads: 201 when the lead was created, 200 when an\nexisting lead was enrolled.", "properties": { "campaign_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Campaign the lead was enrolled in. Also available as enrollment.campaign_id", "title": "Campaign Id" }, "enrollment": { "anyOf": [ { "$ref": "#/components/schemas/Enrollment" }, { "type": "null" } ], "default": null, "description": "Present when a campaign_id was supplied; null otherwise" }, "lead": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "The lead record as stored", "title": "Lead" }, "lead_created": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "true when this request created the lead; false when a lead with this email or LinkedIn URL already existed and was enrolled", "title": "Lead Created" }, "lead_id": { "description": "ID of the created or existing lead", "examples": [ "a1b2c3d4-e5f6-7890-abcd-ef1234567890" ], "title": "Lead Id", "type": "string" }, "message": { "examples": [ "Lead added successfully" ], "title": "Message", "type": "string" }, "sequence_lead_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ID of the campaign sequence entry. Also available as enrollment.sequence_lead_id", "title": "Sequence Lead Id" }, "success": { "default": true, "title": "Success", "type": "boolean" } }, "required": [ "message", "lead_id" ], "title": "AddLeadResponse", "type": "object" } } }, "description": "Response for POST /v1/leads: 201 when the lead was created, 200 when an\nexisting lead was enrolled.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Idempotent-Replay": { "$ref": "#/components/headers/Idempotent-Replay" } } }, "400": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "404": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "409": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints. Also `IDEMPOTENCY_KEY_REUSED` (the key was used with a different request) and `IDEMPOTENCY_IN_PROGRESS` (its first request is still running; carries `Retry-After`).", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "Create a lead, or enrol an existing one, optionally in a campaign.", "tags": [ "Leads" ], "security": [ { "BearerAuth": [ "leads:write" ] } ], "x-required-scope": "leads:write" } }, "/leads/create": { "post": { "deprecated": true, "description": "\nCreates a new lead in your organization without adding it to any campaign.\nThe lead must have first_name, last_name, and at least one of email or linkedin_url.\n\nRequires the `leads:write` scope (or `*`).", "operationId": "post_create_lead_endpoint", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Request body for creating a standalone lead (no campaign required).\n\nRequired: first_name, last_name, and at least one of email OR linkedin_url.", "properties": { "annual_revenue": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Company annual revenue in dollars", "examples": [ 5000000 ], "title": "Annual Revenue" }, "company": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Company name", "examples": [ "Acme Corp" ], "title": "Company" }, "company_website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Lead's company website URL", "examples": [ "https://acmecorp.com" ], "title": "Company Website" }, "custom_fields": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Custom fields as key-value pairs", "examples": [ { "priority": "high", "source": "conference" } ], "title": "Custom Fields" }, "email": { "anyOf": [ { "format": "email", "type": "string" }, { "type": "null" } ], "default": null, "description": "Lead's email address (required if linkedin_url not provided)", "examples": [ "sarah.johnson@acmecorp.com" ], "title": "Email" }, "employees": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of employees at the company", "examples": [ 150 ], "title": "Employees" }, "first_name": { "description": "Lead's first name", "examples": [ "Sarah" ], "title": "First Name", "type": "string" }, "industry": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Industry sector", "examples": [ "Technology" ], "title": "Industry" }, "last_name": { "description": "Lead's last name", "examples": [ "Johnson" ], "title": "Last Name", "type": "string" }, "linkedin_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Lead's LinkedIn profile URL (required if email not provided)", "examples": [ "https://linkedin.com/in/sarahjohnson" ], "title": "Linkedin Url" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Job title", "examples": [ "VP of Sales" ], "title": "Title" } }, "required": [ "first_name", "last_name" ], "title": "CreateLeadRequest", "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "description": "Response for successful standalone lead creation.", "properties": { "lead": { "additionalProperties": true, "description": "The created lead record", "title": "Lead", "type": "object" }, "lead_id": { "description": "ID of the created lead", "examples": [ "a1b2c3d4-e5f6-7890-abcd-ef1234567890" ], "title": "Lead Id", "type": "string" }, "message": { "examples": [ "Lead created successfully" ], "title": "Message", "type": "string" }, "success": { "default": true, "title": "Success", "type": "boolean" } }, "required": [ "message", "lead_id", "lead" ], "title": "CreateLeadResponse", "type": "object" } } }, "description": "Response for successful standalone lead creation.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Link": { "$ref": "#/components/headers/Link" }, "Idempotent-Replay": { "$ref": "#/components/headers/Idempotent-Replay" } } }, "400": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Link": { "$ref": "#/components/headers/Link" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Link": { "$ref": "#/components/headers/Link" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Link": { "$ref": "#/components/headers/Link" } } }, "409": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints. Also `IDEMPOTENCY_KEY_REUSED` (the key was used with a different request) and `IDEMPOTENCY_IN_PROGRESS` (its first request is still running; carries `Retry-After`).", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Link": { "$ref": "#/components/headers/Link" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Link": { "$ref": "#/components/headers/Link" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Link": { "$ref": "#/components/headers/Link" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Link": { "$ref": "#/components/headers/Link" } } } }, "summary": "Create a standalone lead.", "tags": [ "Leads" ], "security": [ { "BearerAuth": [ "leads:write" ] } ], "x-required-scope": "leads:write" } }, "/leads/{lead_id}": { "delete": { "description": "\nWith `campaign_id`, the lead leaves that campaign and its record is\nunchanged. Without it, the lead itself is deleted: its personal and\ncompany data is erased in place and it disappears from every read, while\nan anonymised row remains as the record of the activity that happened.\n\nRequires the `leads:write` scope (or `*`).", "operationId": "delete_remove_lead", "parameters": [ { "in": "path", "name": "lead_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "UUID of the campaign to remove the lead from. Omit to delete the lead itself", "in": "query", "name": "campaign_id", "schema": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "title": "Campaign Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Response for a lead deletion or a removal from a campaign.", "properties": { "campaign_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ID of the campaign the lead was removed from; null when the lead itself was deleted", "title": "Campaign Id" }, "lead_id": { "description": "ID of the deleted or removed lead", "title": "Lead Id", "type": "string" }, "message": { "description": "Success message", "title": "Message", "type": "string" }, "success": { "default": true, "title": "Success", "type": "boolean" } }, "required": [ "message", "lead_id" ], "title": "RemoveLeadResponse", "type": "object" } } }, "description": "Response for a lead deletion or a removal from a campaign.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "400": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "404": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "Delete a lead, or remove it from one campaign.", "tags": [ "Leads" ], "security": [ { "BearerAuth": [ "leads:write" ] } ], "x-required-scope": "leads:write" }, "get": { "description": "\nRetrieve detailed information about a specific lead including\ncontact info, company details, and custom fields.\n\nRequires the `leads:read` scope (or `*`).", "operationId": "get_get_lead", "parameters": [ { "in": "path", "name": "lead_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Response for single lead lookup.", "properties": { "lead": { "$ref": "#/components/schemas/LeadDetail", "description": "Lead details" }, "success": { "default": true, "title": "Success", "type": "boolean" } }, "required": [ "lead" ], "title": "GetLeadByIdResponse", "type": "object" } } }, "description": "Response for single lead lookup.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "404": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "Get a single lead by ID.", "tags": [ "Leads" ], "security": [ { "BearerAuth": [ "leads:read" ] } ], "x-required-scope": "leads:read" }, "patch": { "description": "\nUpdate fields on an existing lead. Only provided fields will be updated.\nSupports partial updates - omit fields you don't want to change.\nAnswers 409 when the new email or LinkedIn URL belongs to another lead, and\n`409 LEAD_SUPPRESSED` when it is on your do-not-contact list.\n\nRequires the `leads:write` scope (or `*`).", "operationId": "patch_update_lead", "parameters": [ { "in": "path", "name": "lead_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Request body for updating a lead. All fields are optional - only include fields you want to update.", "properties": { "annual_revenue": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Company annual revenue in dollars", "examples": [ 5000000 ], "title": "Annual Revenue" }, "company": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Company name", "examples": [ "Acme Corp" ], "title": "Company" }, "company_website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Lead's company website URL", "examples": [ "https://acmecorp.com" ], "title": "Company Website" }, "custom_fields": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Custom fields as key-value pairs", "examples": [ { "source": "conference" } ], "title": "Custom Fields" }, "email": { "anyOf": [ { "format": "email", "type": "string" }, { "type": "null" } ], "default": null, "description": "Lead's email address", "examples": [ "sarah.johnson@acmecorp.com" ], "title": "Email" }, "employees": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of employees at the company", "examples": [ 150 ], "title": "Employees" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Lead's first name", "examples": [ "Sarah" ], "title": "First Name" }, "industry": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Industry sector", "examples": [ "Technology" ], "title": "Industry" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Lead's last name", "examples": [ "Johnson" ], "title": "Last Name" }, "linkedin_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Lead's LinkedIn profile URL", "examples": [ "https://linkedin.com/in/sarahjohnson" ], "title": "Linkedin Url" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Phone number", "examples": [ "+1-555-123-4567" ], "title": "Phone Number" }, "qualification_score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Lead qualification score (0-100)", "examples": [ 85.5 ], "title": "Qualification Score" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Job title", "examples": [ "VP of Sales" ], "title": "Title" } }, "title": "UpdateLeadRequest", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Response for successful lead update.", "properties": { "lead": { "$ref": "#/components/schemas/LeadDetail", "description": "Updated lead details" }, "message": { "description": "Success message", "title": "Message", "type": "string" }, "success": { "default": true, "title": "Success", "type": "boolean" } }, "required": [ "message", "lead" ], "title": "UpdateLeadResponse", "type": "object" } } }, "description": "Response for successful lead update.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "400": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "404": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "409": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "Update a lead by ID.", "tags": [ "Leads" ], "security": [ { "BearerAuth": [ "leads:write" ] } ], "x-required-scope": "leads:write" } }, "/sequence-templates": { "get": { "description": "\nStart from these when building a sequence for POST /v1/campaigns or\nPUT /v1/campaigns/{id}/sequence -- they satisfy the structural validator\n(linkedin_connection->conditional ordering, branch rules); fill in the\nempty message/subject/content fields.\n\nReplaces `GET /campaigns/sequence-templates`.\n\nRequires the `campaigns:read` scope (or `*`).", "operationId": "get_get_sequence_templates", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Blank sequence skeletons for building campaign sequences.", "properties": { "success": { "default": true, "title": "Success", "type": "boolean" }, "templates": { "additionalProperties": true, "description": "channel_type -> blank sequence skeleton (multichannel, linkedin_only, email_only)", "title": "Templates", "type": "object" } }, "required": [ "templates" ], "title": "SequenceTemplatesResponse", "type": "object" } } }, "description": "Blank sequence skeletons for building campaign sequences.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "Blank sequence skeletons (multichannel / linkedin_only / email_only).", "tags": [ "Reference" ], "security": [ { "BearerAuth": [ "campaigns:read" ] } ], "x-required-scope": "campaigns:read" } }, "/webhooks/examples": { "get": { "description": "\nThree `prospect_response` deliveries covering email, LinkedIn, and a\ncampaign with both senders connected. Use them to build and test a receiver\nbefore pointing a live campaign at it. Shapes only -- no real prospect data.\n\nDelivery: `POST` with `Content-Type: application/json`. A delivery that is\nnot answered with a 2xx is retried, up to 5 attempts over 48 hours, so the\nsame reply can arrive more than once -- deduplicate on `idempotency_key`,\nwhich is identical on every redelivery. `timestamp` is ISO 8601 in UTC\nwith a `+00:00` offset.\n\nSigning: when the webhook has a signing secret, every delivery carries\n`X-Signature-256: sha256=`, an HMAC-SHA256 over the exact bytes sent;\nverify it over the raw body before parsing. Set or rotate the secret with\n`POST /campaigns/{campaign_id}/webhooks/{webhook_id}/secret`. A webhook\nwith no secret receives unsigned deliveries.\n\nFields that are present only sometimes: `conversation_owner`, and inside\n`ai_response` the Appointment Setter fields (feature-detect on\n`agent_version`) and the asset-first fields. When the responder did not\nrun, every `ai_response` field is null except `goal`, which carries the\nreason.\n\nReplaces `GET /campaigns/webhook/examples`.\n\nRequires the `campaigns:read` scope (or `*`).", "operationId": "get_get_webhook_examples", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Response containing example webhook payloads for testing.", "properties": { "examples": { "description": "Array of example webhook payloads", "items": { "$ref": "#/components/schemas/WebhookExamplePayload" }, "title": "Examples", "type": "array" }, "success": { "default": true, "title": "Success", "type": "boolean" } }, "required": [ "examples" ], "title": "WebhookExamplesResponse", "type": "object" } } }, "description": "Response containing example webhook payloads for testing.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "401": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "403": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "429": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "500": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } }, "503": { "content": { "application/json": { "schema": { "description": "Standard error response for all API endpoints.", "properties": { "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional error context", "title": "Details" }, "error": { "description": "Error code identifying the type of error", "title": "Error", "type": "string" }, "message": { "description": "Human-readable error message", "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correlation id for this request; also sent as the X-Request-ID header. Quote it to support.", "title": "Request Id" }, "success": { "default": false, "title": "Success", "type": "boolean" } }, "required": [ "error", "message" ], "title": "ErrorResponse", "type": "object" } } }, "description": "Standard error response for all API endpoints.", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } } } }, "summary": "Example payloads your webhook endpoint will receive.", "tags": [ "Reference" ], "security": [ { "BearerAuth": [ "campaigns:read" ] } ], "x-required-scope": "campaigns:read" } } }, "servers": [ { "url": "https://api.versionseven.ai/v1", "description": "Production API Server" } ], "security": [ { "BearerAuth": [] } ], "x-readme": { "explorer-enabled": true, "samples-languages": [ "shell", "node", "ruby", "javascript", "python" ] } }