Hail Forward Targets API

openapi: 3.2.0
info:
  title: Hail Forward Targets API
  description: 'Give your AI agent a voice, a real phone number, and an inbox.


    This file is the source of truth for the Go CLI. Regenerate it after

    changing API routes — see docs/public/contributing.md.'
  version: 0.1.0
servers:
- url: https://api.hail.so
  description: Hail Cloud
tags:
- name: forward-targets
paths:
  /v1/forward-targets:
    get:
      tags:
      - forward-targets
      summary: List Forward Targets
      description: 'List every forward address of the organization with its status.


        An address appears here once it was ever put in a domain''s

        ``forward_to``. Only ``verified`` addresses receive forwards.'
      operationId: list_forward_targets_v1_forward_targets_get
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForwardTargetListResponse'
        '429':
          description: Rate limited. This caller exceeded the general request-rate ceiling. Retry after the Retry-After header (seconds).
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
            RateLimit-Limit:
              description: The request ceiling for the current window.
              schema:
                type: integer
            RateLimit-Remaining:
              description: Requests remaining in the current window.
              schema:
                type: integer
            RateLimit-Reset:
              description: Seconds until the current window resets.
              schema:
                type: integer
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/forward-targets/{address}/resend:
    post:
      tags:
      - forward-targets
      summary: Resend Forward Confirm
      description: 'Send a new confirm link to a pending or stopped forward address.


        Use this when the first mail got lost, or to restart forwarding after a

        spam complaint stopped it. One link per address every 10 minutes.'
      operationId: resend_forward_confirm_v1_forward_targets__address__resend_post
      parameters:
      - name: address
        in: path
        required: true
        schema:
          type: string
          title: Address
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForwardTargetResponse'
        '404':
          description: No such forward address in this organization.
        '409':
          description: The address is already verified, or the organization has no sending identity.
        '429':
          description: A confirm link was sent less than 10 minutes ago, the organization reached its daily confirm-mail limit, or the address already received its daily confirm mails. Rate limited. This caller exceeded the general request-rate ceiling. Retry after the Retry-After header (seconds).
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
            RateLimit-Limit:
              description: The request ceiling for the current window.
              schema:
                type: integer
            RateLimit-Remaining:
              description: Requests remaining in the current window.
              schema:
                type: integer
            RateLimit-Reset:
              description: Seconds until the current window resets.
              schema:
                type: integer
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ForwardTargetListResponse:
      properties:
        items:
          items:
            $ref: '#/components/schemas/ForwardTargetResponse'
          type: array
          title: Items
          description: Every forward address ever configured for this organization.
      type: object
      required:
      - items
      title: ForwardTargetListResponse
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
          description: Path to the invalid field within the request, as a list of keys/indices (e.g. ['body', 'to']).
        msg:
          type: string
          title: Message
          description: Human-readable description of the validation failure.
        type:
          type: string
          title: Error Type
          description: Machine-readable error type code (e.g. 'missing', 'string_type').
        input:
          title: Input
          description: The value that was actually provided and failed validation.
        ctx:
          type: object
          title: Context
          description: Additional machine-readable context for the error, when the error type provides one.
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
          description: 'List of validation errors: each entry gives the field location (loc), the problem (msg), and the error type (type).'
      type: object
      title: HTTPValidationError
    ForwardTargetResponse:
      properties:
        address:
          type: string
          title: Address
          description: Normalized (lower-cased) email address.
        status:
          type: string
          enum:
          - pending
          - verified
          - stopped
          title: Status
          description: '''verified'' receives forwards. ''pending'' was sent a confirm link that is not yet clicked. ''stopped'' got a spam complaint and needs a new confirm link (POST /forward-targets/{address}/resend).'
        pending_reason:
          anyOf:
          - type: string
            enum:
            - confirm_link
            - account_unverified
          - type: 'null'
          title: Pending Reason
          description: 'Why a ''pending'' address is not live. ''confirm_link'': a confirm mail was sent and not yet clicked. ''account_unverified'': the address is a member''s login email whose account email is not verified yet; it goes live on the account verify click, no confirm mail. Null otherwise.'
        verified_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Verified At
          description: When the address was verified, ISO 8601.
        token_sent_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Token Sent At
          description: When the latest confirm link was sent, ISO 8601. Null once verified.
        stopped_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Stopped At
          description: When forwarding was stopped, ISO 8601.
        stopped_reason:
          anyOf:
          - type: string
          - type: 'null'
          title: Stopped Reason
          description: Why forwarding was stopped, e.g. 'complaint'.
      type: object
      required:
      - address
      - status
      title: ForwardTargetResponse
      description: 'One forward address of the organization and whether it may receive

        forwards. Rows come from ``email_forward_targets``; see

        ``hailhq.core.forward_targets``.'