Update warmup settings | TrulyInbox API

Request Body

warmupMaxLimit?number

Max daily warmup sends for this mailbox. 5 up to the plan's per-mailbox cap (maxWarmupPerAccount); above the cap → 022303.

Range5 <= value

timezone?string

IANA timezone identifier (e.g. "America/New_York"). Drives the send-window schedule.

dkimSelector?string

Custom DKIM selector prefix (e.g. "mail" → checks mail._domainkey.yourdomain.com). Leave blank to use common selectors.

senderName?string

warmupFolder?string

replyRateMode?string

Reply-rate mode. LEVEL (auto) follows the reply-rate band for the mailbox's current daily limit; CUSTOM pins a fixed replyRate. When CUSTOM, replyRate is required.

Value in"LEVEL" | "CUSTOM"

replyRate?number

Custom reply rate (%). Required and applied only when replyRateMode=CUSTOM; ignored otherwise. Bounded by the absolute cap here and by the plan's replyRateCap in the service - above the plan cap → 022307.

Range0 <= value <= 65

espMode?string

Value in"AUTO" | "CUSTOM"

espGooglePct?number

CUSTOM mode: must be in [0, 100] and sum with the other two to 100. CUSTOM is plan-gated to Growth+.

espMicrosoftPct?number

CUSTOM mode: must be in [0, 100] and sum with the other two to 100. CUSTOM is plan-gated to Growth+.

espOthersPct?number

CUSTOM mode: must be in [0, 100] and sum with the other two to 100. CUSTOM is plan-gated to Growth+.

language?string

Value in · 12 values

English
Spanish
French
German
Portuguese
Chinese
Japanese
Arabic
Hindi
Russian
Italian
Dutch

industry?string

Value in · 15 values

SaaS
Ecommerce/Retail
B2B Services
Marketing/Advertising
Real Estate
Finance/Fintech
Education/Edtech
Healthcare
Recruitment/HR
Hospitality/Travel
Legal/Consulting
IT/Technology
Professional Services
Nonprofit/NGO
Media/Publishing

topics?array<string>

Value in · 120 values

Process Optimization
Digital Transformation
Automation Solutions
Performance Metrics
Cost Reduction Strategies
Quality Control
Workflow Improvement
Remote Work Solutions
Vendor Management
Supply Chain Efficiency
Emerging Technology Trends
Software Integration
Cybersecurity Best Practices
Data Analytics
Cloud Solutions
Mobile Optimization
System Updates
Security Protocols
Technology Stack
Innovation Strategies
Lead Generation
Customer Acquisition
Brand Positioning
Content Marketing
SEO Strategies
Social Media Marketing
Email Marketing
Conversion Optimization
Customer Retention
Marketing Automation
Budget Planning
Revenue Growth
Cash Flow Management
Investment Strategies
Cost Analysis
ROI Optimization
Financial Planning
Funding Options
Tax Strategies
Financial Compliance
Talent Acquisition
Employee Engagement
Training Programs
Performance Management
Team Building
Leadership Development
Workplace Culture
Benefits Optimization
Diversity & Inclusion
Remote Team Management
Customer Satisfaction
Service Excellence
Client Relations
Support Systems
User Experience
Feedback Management
Customer Success
Retention Programs
Service Quality
Customer Journey
Regulatory Updates
Risk Assessment
Compliance Monitoring
Data Privacy
Security Audits
Legal Requirements
Insurance Reviews
Contract Management
Risk Mitigation
Regulatory Compliance
Market Trends
Industry Reports
Competitive Analysis
Best Practices
Case Studies
Research Findings
Market Opportunities
Industry News
Expert Opinions
Benchmarking
Skills Training
Certification Programs
Career Growth
Professional Networking
Industry Events
Learning Opportunities
Mentorship
Leadership Training
Continuing Education
Professional Resources
Business Strategy
Growth Planning
Market Expansion
Partnership Opportunities
Strategic Initiatives
Long-term Planning
Goal Setting
Vision Development
Strategic Analysis
Business Development
Year-end Planning
Quarterly Reviews
Holiday Preparations
New Year Goals
Summer Strategies
Industry Conferences
Annual Reports
Budget Cycles
Tax Season
Planning Sessions
Team Communication
Project Management
Collaboration Tools
Meeting Efficiency
Internal Communications
Cross-department Coordination
Stakeholder Management
Communication Strategies
Team Productivity
Collaboration Best Practices

contentMode?string

Per-account send-content mode. default → global pool; industry_topic → requires industry + ≥1 topic; custom_prompt → requires customPrompt. Regenerated by the daily content-refresh cron.

Value in"default" | "industry_topic" | "custom_prompt"

customPrompt?string

Verbatim generation prompt used when contentMode=custom_prompt.

Lengthlength <= 2000

schedule?array<UpdateWarmupScheduleDto>

7-14 rows: every dayOfWeek 0-6 present with 1-2 weighted slots. Legacy 7-row bodies (one slot/day) remain valid.

templateCollectionId?number | null

Template collection to draw send content from (must belong to the same workspace as the account). Null clears the assignment (100% AI).

templateRatioPercent?number

Per-send chance (%) of drawing from templateCollectionId instead of AI-generated content.

Range0 <= value <= 100

Response Body

curl -X PATCH "https://lynx-api.trulyinbox.com/v2/workspaces/0/accounts/0/warmup/settings" \
  -H "Content-Type: application/json" \
  -d '{
    "warmupMaxLimit": 30,
    "timezone": "America/New_York",
    "dkimSelector": "mail",
    "senderName": "John Doe",
    "warmupFolder": "Warmup",
    "replyRateMode": "LEVEL",
    "replyRate": 40,
    "espMode": "AUTO",
    "espGooglePct": 30,
    "espMicrosoftPct": 50,
    "espOthersPct": 20,
    "language": "English",
    "industry": "SaaS",
    "topics": [
      "Lead Generation",
      "Customer Retention"
    ],
    "contentMode": "default",
    "customPrompt": "Write friendly check-in emails from a SaaS founder to early customers.",
    "schedule": [
      {
        "dayOfWeek": 0,
        "slotIndex": 0,
        "weight": 100,
        "enabled": true,
        "startTime": "09:00",
        "endTime": "17:00"
      }
    ],
    "templateCollectionId": 3,
    "templateRatioPercent": 30
  }'

curl -X PATCH "https://lynx-api.trulyinbox.com/v2/workspaces/0/accounts/0/warmup/settings" \  -H "Content-Type: application/json" \  -d '{    "warmupMaxLimit": 30,    "timezone": "America/New_York",    "dkimSelector": "mail",    "senderName": "John Doe",    "warmupFolder": "Warmup",    "replyRateMode": "LEVEL",    "replyRate": 40,    "espMode": "AUTO",    "espGooglePct": 30,    "espMicrosoftPct": 50,    "espOthersPct": 20,    "language": "English",    "industry": "SaaS",    "topics": [      "Lead Generation",      "Customer Retention"    ],    "contentMode": "default",    "customPrompt": "Write friendly check-in emails from a SaaS founder to early customers.",    "schedule": [      {        "dayOfWeek": 0,        "slotIndex": 0,        "weight": 100,        "enabled": true,        "startTime": "09:00",        "endTime": "17:00"      }    ],    "templateCollectionId": 3,    "templateRatioPercent": 30  }'

{
  "data": {
    "warmupMinLimit": 0,
    "warmupMaxLimit": 0,
    "warmupCurrentLimit": 0,
    "maxWarmupPerAccount": 0,
    "replyRateCap": 0,
    "dkimSelector": "string",
    "senderName": "string",
    "warmupFolder": "string",
    "replyRateMin": 0,
    "replyRateMax": 0,
    "replyRateCustom": true,
    "threadTendencyMin": 0,
    "threadTendencyMax": 0,
    "espMode": "string",
    "espGooglePct": 0,
    "espMicrosoftPct": 0,
    "espOthersPct": 0,
    "customEspAllowed": true,
    "customContentAllowed": true,
    "templatesAllowed": true,
    "customScheduleAllowed": true,
    "customLanguageAllowed": true,
    "replyRateAllowed": true,
    "planName": "string",
    "language": "string",
    "industry": "string",
    "topics": [
      "string"
    ],
    "contentMode": "default",
    "customPrompt": "string",
    "timezone": "string",
    "warmupStrategy": "string",
    "schedule": [
      {
        "id": 0,
        "dayOfWeek": 0,
        "slotIndex": 0,
        "weight": 0,
        "enabled": true,
        "startTime": "string",
        "endTime": "string"
      }
    ],
    "templateCollectionId": 0,
    "templateRatioPercent": 0
  },
  "meta": {
    "request_id": "req_2f1c…",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "details": {},
    "retry_after": 34
  },
  "meta": {
    "request_id": "req_2f1c…",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "details": {},
    "retry_after": 34
  },
  "meta": {
    "request_id": "req_2f1c…",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

Path Parameters

Request Body

Response Body

200

4XX

5XX