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

# Read what a new outbound agent starts with

> The configuration and the prompts a new outbound agent starts with (per email, per LinkedIn step and for replies), and whether person research can be switched on. The same in every workspace.



## OpenAPI

````yaml /openapi.json get /outbound-agents/defaults/
openapi: 3.1.0
info:
  contact:
    email: support@getoneprofile.ai
    name: Oneprofile Support
  description: >-
    REST API reference for Oneprofile, the GTM data layer for your CRM. Manage
    tables, enrichments, and integrations. Authenticate with an API key to get
    started.
  termsOfService: https://www.getoneprofile.ai/terms
  title: API Reference | Oneprofile
  version: '0.0'
servers:
  - url: https://api.getoneprofile.ai
security: []
tags:
  - description: >-
      The docked AI Assistant: its general chat about the workspace and the
      product, streamed as Server-Sent Events, and the one list of a person's
      threads across every assistant, with pin, rename, delete and the
      search-to-table link.
    name: assistant
  - description: >-
      The messages a person keeps to send the assistant again: the ones the
      workspace saved and the ones that ship with the product, with save,
      rename, edit and delete.
    name: assistant-prompt
  - description: >-
      Granted workspace actions: what the AI Assistant proposed or applied in a
      conversation, the approve and dismiss decisions on each card, the
      workspace's spend threshold and default grants, and the eight verbs.
    name: workspace-actions
  - description: >-
      The Getting started checklist: a workspace's progress through the six
      steps from its first people search to its first launched sequence.
    name: onboarding
  - description: Senders, connected mailboxes, tags, and the Google connect flow.
    name: senders
  - description: The workspace do-not-contact list, enforced before every send.
    name: suppression
  - description: >-
      The workspace's recontact rule: how long before anyone hears from us
      again.
    name: contact_cooldown
  - description: 'Sequence authoring: the graph, the table-backed audience, previews.'
    name: sequences
  - description: >-
      The outbound agent behind a sequence: the voice it writes in, its
      per-message prompts, what it wrote and what people told it.
    name: outbound-agents
  - description: >-
      The LinkedIn channel: connecting an account to a sender, its safety limits
      and history, and the protocol the browser extension speaks.
    name: linkedin
  - description: >-
      The approval queue: everything waiting on a person across every sender and
      channel, and the workspace's manual or automatic modes per channel.
    name: outreach
  - description: 'The unified outreach inbox: threads, replies, labels, events.'
    name: inbox
  - description: 'The AI reply layer: workspace settings, drafts, and approval.'
    name: inbox-ai
  - description: Notification rules, per-user preferences, and the Slack connection.
    name: notifications
  - description: Endpoints for seeing all available integration types.
    name: integration-types
  - description: Endpoints for creating and managing integrations.
    name: integrations
  - description: Endpoints for the generic OAuth install/claim app-listings engine.
    name: app-listings
  - description: Endpoints for creating and managing API keys.
    name: apikey
  - description: >-
      AI apps connected to the workspace: Claude, ChatGPT, Claude Code or any
      other MCP client a person signed in to Oneprofile's MCP server with.
    name: ai_apps
  - description: Endpoints for managing billing and subscription information.
    name: billing
  - description: Endpoints for creating and managing tables.
    name: tables
  - description: Endpoints for table columns, formula previews, and on-demand column runs.
    name: table-columns
  - description: Endpoints for table rows and manual cell edits.
    name: table-rows
  - description: Endpoints for observing and cancelling table recompute runs.
    name: table-runs
  - description: >-
      Endpoints for org-shared per-column display preferences: hidden, pinned,
      width, and colour tint.
    name: table-ui-prefs
  - description: >-
      Endpoints for the org-shared names given to the column tint palette: what
      this organisation calls each colour. Org-level, not per-table.
    name: table-column-color-labels
  - description: >-
      Endpoints for the enrichment action catalog, model list, presets, draft
      generation, and saved agents.
    name: table-enrichments
  - description: >-
      Endpoints for an agent's Preview: example rows run one at a time, and a
      Looks good on each. Needs work lives under agent-learnings.
    name: agent-training
  - description: >-
      An agent's learnings, the one-line rules it follows on every output, and
      the thumbs down that teaches them: give one with what was wrong, list the
      ones on a subject, Undo one, and price the redo it would run.
    name: agent-learnings
  - description: >-
      The durable audit trail of a table's enrichment actions: configured,
      edited, run, cancelled, and settled cost.
    name: table-enrichment-audit-logs
  - description: Endpoints for saving and applying column templates.
    name: table-templates
  - description: Server-sent change feed for a table's grid.
    name: table-events
  - description: 'Endpoints for org-shared saved table views: sort, filters, hidden columns.'
    name: table-views
  - description: >-
      Endpoints for PER-USER table preferences: favourites and recently opened.
      Unlike the rest of the table surface these are personal, so two members of
      one organisation legitimately see different answers.
    name: table-user-prefs
  - description: >-
      Endpoints for building a table from an uploaded CSV: upload and preview
      the inferred columns, commit the reviewed mapping, then poll the row load.
    name: table-imports
  - description: Endpoint for downloading a table's rows as CSV.
    name: table-export
  - description: >-
      Endpoints for the integration a table imports from: attach and preview it,
      promote imported fields into columns, and run the import on demand.
    name: table-sources
  - description: >-
      Endpoints for a table's recurring import cadence: set it, pause it, and
      read the next fire times.
    name: table-schedules
  - description: >-
      Endpoints for pushing a table's rows out to a connected integration: list
      writable destinations, derive their write capabilities, and map export
      columns.
    name: table-writeback
  - description: >-
      Endpoints backing a lookup column's setup: the connections whose records a
      column could read, and the identity fields one record type can be looked
      up by.
    name: table-integration-lookup
  - description: >-
      Endpoints for sourcing leads from the lead database: count and preview
      matches, land them in a table, and keep saved searches. Alongside people
      and company searches, leads can be sourced from buying signals (what a
      company or person just did), with a catalogue endpoint behind the picker
      that builds them.
    name: find-leads
  - description: >-
      Endpoints for discovering a domain's subdomains from public certificate
      logs and landing the results in a table.
    name: find-subdomains
  - description: Endpoints for the credit balance meter and usage reporting.
    name: credits
  - description: >-
      Endpoints for the workspace referral program: the shareable link, the
      friends who joined through it, and claiming a code after signup.
    name: referral
  - description: >-
      Endpoints for the affiliate program's own dashboard: enrolling and
      claiming a code, the summary, stats and activity feed, the commission
      ledger, and identity verification and payouts.
    name: affiliate
  - description: >-
      Endpoints for recording where a new workspace came from: the marketing
      page or campaign its signup link carried, sent once after signup.
    name: attribution
  - description: >-
      Endpoints for the design partner program's customer surface: whether this
      workspace is a design partner, the badges its feedback has earned, and
      sending and reading that feedback.
    name: design-partner
  - description: >-
      Endpoints for the org-level AI business context (company description,
      ideal customer profile, buyer personas, interest signals and social
      proof), plus domain-based generation and the reference documents whose
      summaries ride alongside those fields.
    name: ai-context
  - description: >-
      Endpoints for the signed-in user's Google Drive connection: starting and
      finishing the OAuth grant, checking or dropping it, and minting the
      short-lived token the Google Picker needs.
    name: google-drive
paths:
  /outbound-agents/defaults/:
    get:
      tags:
        - outbound-agents
      summary: Read what a new outbound agent starts with
      description: >-
        The configuration and the prompts a new outbound agent starts with (per
        email, per LinkedIn step and for replies), and whether person research
        can be switched on. The same in every workspace.
      operationId: read_outbound_defaults
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutboundDefaultsReadSchema'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenResponse'
          description: Forbidden
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityResponse'
          description: Invalid request made to the API.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Internal server error.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Bad gateway error.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Service unavailable.
      security:
        - APIKeyHeader: []
        - HTTPBearer: []
components:
  schemas:
    OutboundDefaultsReadSchema:
      description: >-
        What a new outbound agent starts with, and whether person research can
        be switched on.
      properties:
        default_config:
          $ref: '#/components/schemas/OutboundAgentConfig'
        default_email_prompts:
          items:
            type: string
          title: Default Email Prompts
          type: array
        default_linkedin_prompts:
          additionalProperties:
            type: string
          title: Default Linkedin Prompts
          type: object
        default_reply_prompt:
          title: Default Reply Prompt
          type: string
        person_research_available:
          default: false
          description: >-
            Whether person research can be switched on: the catalog offers the
            read.
          title: Person Research Available
          type: boolean
      required:
        - default_config
        - default_email_prompts
        - default_linkedin_prompts
        - default_reply_prompt
      title: OutboundDefaultsReadSchema
      type: object
    UnauthorizedResponse:
      properties:
        detail:
          description: The detail of why the request is unauthorized.
          title: Detail
          type: string
      required:
        - detail
      title: UnauthorizedResponse
      type: object
    ForbiddenResponse:
      properties:
        detail:
          description: The detail of why the request is forbidden.
          title: Detail
          type: string
      required:
        - detail
      title: ForbiddenResponse
      type: object
    UnprocessableEntityResponse:
      properties:
        detail:
          description: >-
            The detail of the error. This is the error message to show to the
            user. You should also use the issues field to show more detailed
            error messages per field. Use this field for a single liner error
            message.
          title: Detail
          type: string
        issues:
          description: >-
            The issues that caused the error. There can be multiple issues. Each
            issue is a user-facing error message.
          items:
            $ref: '#/components/schemas/UnprocessableEntityIssue'
          title: Issues
          type: array
      required:
        - detail
        - issues
      title: UnprocessableEntityResponse
      type: object
    ServerErrorResponse:
      properties:
        detail:
          description: The detail of why the server returned an error.
          title: Detail
          type: string
      required:
        - detail
      title: ServerErrorResponse
      type: object
    OutboundAgentConfig:
      additionalProperties: false
      description: >-
        The versioned configuration one outbound agent carries, stored as JSON
        on its row.


        Everything a person sets on the Agent tab that is not already a column
        of

        the saved-agent row (``model_key`` and the research switch live there).

        ``message_prompts`` is keyed by an opaque slot key the caller mints (the

        step id); the agent never learns what a slot means.
      properties:
        campaign:
          anyOf:
            - $ref: '#/components/schemas/CampaignBrief'
            - type: 'null'
        cta_label:
          anyOf:
            - maxLength: 200
              type: string
            - type: 'null'
          title: Cta Label
        cta_url:
          anyOf:
            - maxLength: 2000
              type: string
            - type: 'null'
          title: Cta Url
        goal:
          default: ''
          maxLength: 1000
          title: Goal
          type: string
        language:
          default: English
          maxLength: 16
          title: Language
          type: string
        message_prompts:
          additionalProperties:
            maxLength: 4000
            type: string
          maxProperties: 50
          propertyNames:
            maxLength: 64
          title: Message Prompts
          type: object
        person_research:
          default: false
          title: Person Research
          type: boolean
        personality_preset:
          $ref: '#/components/schemas/PersonalityPreset'
          default: direct
        personality_prompt:
          default: ''
          maxLength: 4000
          title: Personality Prompt
          type: string
        reply_drafting:
          default: true
          title: Reply Drafting
          type: boolean
        reply_labels:
          default:
            - positive
          items:
            $ref: '#/components/schemas/ReplyLabel'
          maxItems: 8
          title: Reply Labels
          type: array
        reply_prompt:
          default: ''
          maxLength: 4000
          title: Reply Prompt
          type: string
        translate:
          default: false
          title: Translate
          type: boolean
        write_from_excluded_column_ids:
          items:
            maxLength: 64
            type: string
          maxItems: 200
          title: Write From Excluded Column Ids
          type: array
      title: OutboundAgentConfig
      type: object
    UnprocessableEntityIssue:
      properties:
        input:
          anyOf:
            - type: string
            - type: integer
            - type: number
            - type: boolean
            - items: {}
              type: array
            - additionalProperties: true
              type: object
          description: The user's input that caused the error.
          title: Input
        loc:
          description: >-
            The location of the error. Always contains 1 or 2 elements. The
            first element is the type of location (e.g. 'body', 'query', 'path',
            'header'). The second element is the name of the field that caused
            the error. If the error is not related to a specific field, the
            second element is not present.
          items:
            type: string
          title: Loc
          type: array
        msg:
          description: The message of the error. The error message to show to the user.
          title: Msg
          type: string
        type:
          description: >-
            The type of the error. Useful for frontend code to handle different
            types of errors.
          title: Type
          type: string
      required:
        - loc
        - msg
        - type
        - input
      title: UnprocessableEntityIssue
      type: object
    CampaignBrief:
      additionalProperties: false
      description: |-
        What one sequence's campaign is: the tested campaign it runs and why.

        Written by tailoring and by nothing else; the Agent tab reads it and
        never sends it back (the service keeps the stored one on every other
        write). Tailoring now rewrites the steps' instructions themselves and
        writes only ``reason`` and ``goal`` here. ``audience``, ``why_now``,
        ``angle`` and ``step_notes`` are what it wrote before: kept, and still
        read by the writer, for the agents that carry them. They were written by
        a model from the audience table, so they are background, never facts:
        only ``intent``, the person's own words, may be stated as fact.
      properties:
        angle:
          default: ''
          maxLength: 300
          title: Angle
          type: string
        audience:
          default: ''
          maxLength: 300
          title: Audience
          type: string
        campaign_key:
          maxLength: 64
          title: Campaign Key
          type: string
        chosen_by_person:
          default: false
          title: Chosen By Person
          type: boolean
        goal:
          default: ''
          maxLength: 1000
          title: Goal
          type: string
        intent:
          default: ''
          maxLength: 500
          title: Intent
          type: string
        minted:
          items:
            maxLength: 64
            type: string
          maxItems: 50
          title: Minted
          type: array
        reason:
          default: ''
          maxLength: 300
          title: Reason
          type: string
        step_notes:
          additionalProperties:
            maxLength: 300
            type: string
          maxProperties: 50
          propertyNames:
            maxLength: 64
          title: Step Notes
          type: object
        table_name:
          default: ''
          maxLength: 255
          title: Table Name
          type: string
        tailoring_off:
          default: false
          title: Tailoring Off
          type: boolean
        why_now:
          anyOf:
            - maxLength: 300
              type: string
            - type: 'null'
          title: Why Now
      required:
        - campaign_key
      title: CampaignBrief
      type: object
    PersonalityPreset:
      description: >-
        The voice an agent writes in. Each preset is a real prompt; CUSTOM is
        the author's.
      enum:
        - direct
        - consultative
        - bold
        - custom
      title: PersonalityPreset
      type: string
    ReplyLabel:
      description: >-
        One of the inbox's built-in labels, as a sequence's reply settings name
        it.


        The tick boxes under Write replies: the labels whose replies the agent

        writes an answer to. The inbox ranks above this package, so its

        ``SeededLabel`` cannot be named here; the inbox maps its label to this

        one (``inbox.types.REPLY_LABEL_OF``), never the other way round. The

        value is a stored key, never shown: ``REPLY_LABEL_NAMES`` holds the

        words, which are the inbox labels' own names.
      enum:
        - positive
        - negative
        - meeting_booked
        - meeting_completed
        - closed
        - wrong_contact
        - out_of_office
        - auto_reply
      title: ReplyLabel
      type: string
  securitySchemes:
    APIKeyHeader:
      in: header
      name: X-API-Key
      type: apiKey
    HTTPBearer:
      scheme: bearer
      type: http

````

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