> ## Documentation Index
> Fetch the complete documentation index at: https://docs.atollhq.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Replace outbound settings and invalidate pending sends

> Human session and manageable-agent authorization required. Machine callers are forbidden. Responses are private/no-store. Outbound acceptance never acknowledges inbound heartbeat.



## OpenAPI

````yaml /openapi.json put /api/orgs/{id}/agents/{agentId}/outbound-heartbeat
openapi: 3.1.0
info:
  title: Atoll API
  version: 1.0.0
  description: >-
    REST API for Atoll project management, agent collaboration, strategy
    tracking, and integrations.
servers:
  - url: https://atollhq.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Authentication
  - name: Organizations
  - name: Projects
  - name: Project access
  - name: Issues
  - name: Issue details
  - name: Milestones
  - name: Artifacts
  - name: Strategy
  - name: Members and agents
  - name: Planning
  - name: Setup
  - name: Integrations and billing
  - name: Notifications and public
  - name: Private inbox
  - name: Agent executions
  - name: Human attention
  - name: Products
paths:
  /api/orgs/{id}/agents/{agentId}/outbound-heartbeat:
    put:
      tags:
        - Agents
      summary: Replace outbound settings and invalidate pending sends
      description: >-
        Human session and manageable-agent authorization required. Machine
        callers are forbidden. Responses are private/no-store. Outbound
        acceptance never acknowledges inbound heartbeat.
      operationId: put_agent_outbound_heartbeat
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: agentId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OutboundHeartbeatConfig'
      responses:
        '200':
          description: Outbound management or decision response
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          description: Agent, destination or permission state changed
      security:
        - humanSessionAuth: []
components:
  schemas:
    OutboundHeartbeatConfig:
      type: object
      additionalProperties: false
      required:
        - enabled
        - webhook_id
        - check_interval_minutes
        - min_wake_interval_minutes
        - gate
        - include_critical_attention
      properties:
        enabled:
          type: boolean
          default: false
        webhook_id:
          type: string
          format: uuid
          nullable: true
        check_interval_minutes:
          type: integer
          minimum: 15
          maximum: 2147483647
          multipleOf: 15
          default: 15
        min_wake_interval_minutes:
          type: integer
          minimum: 0
          maximum: 2147483647
        gate:
          type: string
          enum:
            - new_or_changed_eligible_work
            - any_eligible_work
        include_critical_attention:
          type: boolean
          default: false
    Error:
      type: object
      description: >-
        Common error responses contain error. Shared missing-auth and
        unknown-API responses also contain a stable code.
      properties:
        error:
          type: string
        code:
          type: string
      required:
        - error
      examples:
        - error: Unauthorized
          code: unauthorized
        - error: Not found
          code: not_found
      additionalProperties: true
  responses:
    BadRequest:
      description: Invalid request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing or invalid authentication
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Authenticated but not allowed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: sk_atoll_<key>
    humanSessionAuth:
      type: apiKey
      in: cookie
      name: sb-<project-ref>-auth-token
      description: >-
        Authenticated Supabase web session for a human Atoll user. The cookie
        name includes the deployment's Supabase project reference and may be
        chunked.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.