Skip to main content
Follow this page for production-affecting changes to the Breakcold REST API and MCP. Product updates remain available from What’s New inside Breakcold, and related product posts link back here when developer action is relevant. Use the RSS button at the top of this page to subscribe, or add https://docs.breakcold.com/api/changelog/rss.xml to your RSS reader.
​
MCPChanged
Regional MCP requests use universal gateway

​
Regional MCP OAuth Compatibility

Legacy regional MCP endpoints now proxy MCP traffic and discovery requests through the universal gateway.

​
Changes

  • Regional MCP requests are forwarded to the universal MCP gateway.
  • Regional OAuth discovery endpoints advertise the universal gateway.
  • Existing MCP request methods, query parameters, authorization, sessions, and bodies are preserved.
​
RESTChangedFixed
Safer creates and managed-task updates

​
Identity Resolution API Safeguards

REST APIs now prevent ambiguous record creation and reject direct changes to source-managed tasks.

​
Changes

  • Record creation now blocks identity matches requiring review instead of silently creating a potentially duplicate record.
  • Repeated requests with the same idempotency key can return the existing operation without emitting a duplicate creation event.
  • Updates to source-managed tasks reject changes to title, description, due date, or status.
  • Manual deletion of source-managed tasks is rejected.
  • Identity-resolution conflicts are returned as structured HTTP 409 conflict errors.

​
Migration

  1. Handle HTTP 409 conflicts for identity matches and route them to review.
  2. Do not update or delete source-managed tasks directly; resolve them through the task workspace.
​
BreakingRESTMCPChanged
Explicit approved scopes required

​
OAuth scopes are now required

OAuth-authenticated REST and MCP requests now require recognized Breakcold API scopes.

​
Changes

  • Authorization requests reject empty or unsupported scopes with invalid_scope.
  • Access tokens retain only scopes approved in the grant.
  • Gateway-authenticated requests reject missing or unknown-only scopes with insufficient_scope.
  • Verified OAuth JWTs must contain at least one recognized public API scope.

​
Migration

  1. Update OAuth authorization requests to include one or more supported Breakcold API scopes.
  2. Ensure clients handle invalid_scope and insufficient_scope responses.
​
MCPChanged
MCP task timestamps preserve exact times

​
Support Task Due Timestamps

MCP task creation and updates now preserve supplied due timestamps.

​
Changes

  • Task creation accepts and stores exact due timestamps.
  • Task updates preserve exact due timestamps.
  • Clearing a due timestamp removes the associated time metadata.
​
WebhooksZapierMakeChanged
Use cryptographically secure secrets

​
Strengthen Webhook Secrets

New outbound webhook and integration signing secrets now contain 256 bits of cryptographically secure randomness.

​
Changes

  • New signing secrets use the whsec_ prefix followed by 64 hexadecimal characters.
  • Outbound webhook signature verification remains HMAC-SHA256 compatible.
  • New bearer secret identifiers are 64-character hexadecimal values.
​
RESTChanged
Restricts record-only conversation visibility

​
Record-Scoped Inbox Access

Public API conversation access now requires record links for record-scoped permissions.

​
Changes

  • Users with record-scoped read permission can access only conversations linked to a CRM record.
  • Users with record-scoped reply permission can reply only to conversations linked to a CRM record.
  • Users with all-message permissions retain access without a record link.
​
NewRESTMCPZapier
Delete tasks through integrations

​
Add Task Deletion

A new task deletion action is available across REST, MCP, Zapier, and Make.

​
Changes

  • Added DELETE /tasks/{taskId} requiring the tasks:write scope.
  • Added the tasks_delete MCP tool.
  • Added task deletion actions to Zapier and Make.
  • Deletion is idempotent and returns deletedId.
​
RESTChanged
Higher concurrency for API requests

​
Public API Rate Limit Scaling

Public API rate limiting now distributes capacity across multiple shards to better handle concentrated request traffic.

​
Changes

  • Public API rate-limit capacity is distributed across 20 shards.
  • Concurrent API traffic is less likely to contend on a single rate-limit record.
​
RESTNew
New GET and POST unsubscribe routes

​
Email Unsubscribe Endpoint Added

Production email unsubscribe handling is now available through a public HTTP endpoint.

​
Changes

  • Added GET /email/unsubscribe for displaying unsubscribe confirmation.
  • Added POST /email/unsubscribe for human-confirmed and RFC 8058 one-click unsubscribe requests.
  • POST requests return idempotent success responses for repeated unsubscribe actions.
​
MCPChanged
Outbound tools default to drafts

​
MCP Sending Requires Confirmation

MCP outbound message tools now return a draft preview unless delivery is explicitly requested.

​
Changes

  • inbox_conversations_compose accepts sendMode=“draft” or “send”.
  • inbox_messages_send accepts sendMode=“draft” or “send”.
  • Omitting sendMode returns a non-sending preview.
  • sendMode=“send” preserves immediate delivery behavior.
  • Invalid sendMode values return an error.

​
Migration

  1. Add sendMode=“send” to calls intended to deliver messages immediately.
  2. Handle draft responses with sent=false and confirmationRequired=true.
​
MakeChangedFixed
Preserves component relationship metadata

​
Make Synchronization Handles Relationships

Make app synchronization now reads and maintains connection and webhook relationships when comparing or updating components.

​
Changes

  • Webhook connection relationships are retrieved when list responses omit them.
  • Instant-trigger module webhook relationships are retrieved before synchronization.
  • Component updates preserve configured connections, CRUD settings, and webhook associations.
  • Deployment drift errors include the specific actions required to reconcile differences.
​
MCPChangedFixed
MCP lists now return partial pages

​
MCP Pagination Behavior Updated

MCP list tools now return partial pages when filtering exhausts a raw batch, allowing callers to continue with the returned cursor.

​
Changes

  • List operations perform one paginated query per invocation.
  • Filtered results may contain fewer items than the requested limit.
  • Returned cursors continue from the next raw page or remaining batch position.
  • Callers should keep requesting pages until pagination indicates no more results.

​
Migration

  1. Continue following returned cursors until hasMore is false or the cursor is null.
  2. Do not assume every page contains the requested number of items.
​
RESTZapierMakeNew
Manage private inbox drafts

​
Conversation Draft API

New REST, Zapier, and Make operations let authenticated users manage conversation drafts.

​
Changes

  • Added endpoints to create or update a conversation draft.
  • Added an endpoint to retrieve the authenticated user’s draft.
  • Added an endpoint to clear the authenticated user’s draft.
  • HTML draft content is accepted for email conversations only.
​
MakeRESTWebhooksNew
REST modules and instant triggers

​
Make integration available

Make users can access Breakcold REST operations and event triggers through a generated integration.

​
Changes

  • Added 57 Make REST modules covering supported Breakcold operations.
  • Added 14 instant webhook triggers for supported event types.
  • Added a universal module for relative Breakcold API paths.
  • Webhook subscriptions now enforce event and object-type filters before delivery.
​
ZapierChangedFixed
Selectors and structured inputs now work consistently

​
Zapier Integration Behavior Updates

The generated Zapier integration now exposes dynamic choices and normalizes request and response data for production workflows.

​
Changes

  • Adds dynamic Zapier choices for workspaces, records, CRM fields, conversations, messages, meetings, notes, and tasks.
  • Parses JSON-formatted array and object inputs before sending requests.
  • Maps the Zapier idempotencyKey field to the API clientMessageId field.
  • Normalizes search and action responses for Zapier compatibility.
  • Updates authentication setup help with a direct developer documentation link.
​
RESTNew
Download linked email attachments

​
Add Attachment Download Endpoint

A new authenticated REST endpoint serves prepared record email attachments for production clients.

​
Changes

  • Added GET /record-email-attachment-download.
  • Requires bearer authentication.
  • Returns the prepared attachment stream with its content metadata.
​
RESTChangedFixed
Cleans linked conversations after deletion

​
CRM Deletion Cleanup Added

Deleting a CRM object now schedules cleanup of conversation links associated with that object type.

​
Changes

  • CRM object deletion schedules removal of associated conversation-record links.
  • Cleanup runs asynchronously after the deletion request.
​
MCPChanged
Reliable filtered conversation pagination

​
Paginated Inbox Results

MCP-backed inbox conversation listing now supports selective indexes and stable cursors for filtered views.

​
Changes

  • Filtered conversation views use matching lifecycle, channel, mailbox, status, and account indexes when available.
  • Pagination cursors retain filter scope and resume correctly after post-filtering.
  • Large restricted conversation views check permissions only for candidate conversations instead of scanning unrelated memberships.
​
BreakingRESTMCP
Record creation validation

​
Record creation now requires complete initial fields

Record creation now rejects empty field payloads and enforces fields configured as required for the target object.

​
Action required

  • REST POST /records requires a non-empty fields object.
  • Include every required field unless it has a configured default.
  • REST retries may use the optional Idempotency-Key header.
  • MCP records_create requires a stable idempotencyKey tool argument.

​
Migration

  1. List fields with GET /crm/objects/{objectTypeId}/fields.
  2. Include values for required fields without defaults.
  3. Reuse the same idempotency value when retrying the same logical request.
See Create a record and List CRM fields.