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

# Revoke price negotiation

> Take the authorisation back.



## OpenAPI

````yaml /api-reference/openapi.json delete /api/v1/public/outreach/sources/{source_id}/negotiation
openapi: 3.1.0
info:
  title: Hikoo REST API
  description: >-
    Programmatic access to your Hikoo data: AI citations, prompts, topics,
    competitors, sources, audits, site health, indexation, AI-crawler traffic,
    and outreach. Authenticate with a personal API key sent as `Authorization:
    Bearer <key>`. Create one in the dashboard under **Settings > API keys**.
  version: 1.0.0
servers:
  - url: https://api.tryhikoo.com
    description: Production
security:
  - apiKey: []
tags:
  - name: Account
    description: The user behind the API key.
  - name: Workspaces
    description: >-
      Workspaces the user belongs to. Use them to find the websites you can
      query.
  - name: Websites
    description: Every website the user can access, with its subscription status.
  - name: Website
    description: Metadata and plan of one website.
  - name: Citations
    description: >-
      Every time an AI assistant answers one of your prompts, Hikoo stores the
      answer as a citation. These endpoints list them and aggregate them by
      platform, source, sentiment and match type.
  - name: Prompts
    description: >-
      Prompts are the questions Hikoo sends to AI assistants for a website.
      Create, edit, archive and restore them, and read their visibility, answers
      and citations.
  - name: Topics
    description: Topics group prompts. Every prompt belongs to one topic.
  - name: Search queries
    description: >-
      The web searches AI assistants run internally (query fan-out) before
      answering your prompts.
  - name: URL lookup
    description: >-
      Where one URL shows up, across AI-cited sources and AI-crawler traffic, in
      one call.
  - name: Competitors
    description: >-
      Tracked competitors, their share of voice, and the competitor suggestions
      Hikoo detects in AI answers.
  - name: Source intelligence
    description: >-
      The domains and pages AI assistants cite for your prompts, and who appears
      on them.
  - name: Audits
    description: GEO audits of a full site, a list of pages or a single URL.
  - name: Health
    description: >-
      Site-level checks for AI readiness (robots.txt, llms.txt, sitemap) and
      improvement suggestions.
  - name: Indexation
    description: >-
      The pages Hikoo crawled on your website, their category, health and
      errors.
  - name: Content gaps
    description: >-
      Topics where AI assistants answer without citing you, with a content brief
      for each.
  - name: Agent analytics
    description: Traffic from AI crawlers and AI agents on your website.
  - name: Outreach
    description: >-
      The outreach agent: sources worth getting cited on, their contacts, the
      pitches waiting for approval, follow-ups, and what the agent is allowed to
      do on its own.
paths:
  /api/v1/public/outreach/sources/{source_id}/negotiation:
    delete:
      tags:
        - Outreach
      summary: Revoke price negotiation
      description: Take the authorisation back.
      operationId: >-
        revoke_negotiation_api_v1_public_outreach_sources__source_id__negotiation_delete
      parameters:
        - name: source_id
          in: path
          required: true
          schema:
            type: integer
            title: Source Id
        - name: website_id
          in: query
          required: true
          schema:
            type: integer
            description: Target website id
            title: Website Id
          description: Target website id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutreachSourceDetail'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    OutreachSourceDetail:
      properties:
        id:
          type: integer
          title: Id
        domain:
          type: string
          title: Domain
        status:
          $ref: '#/components/schemas/OutreachStatus'
        status_set_by:
          $ref: '#/components/schemas/OutreachActor'
        status_updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Status Updated At
        priority:
          type: number
          title: Priority
          default: 0
        priority_factors:
          items:
            $ref: '#/components/schemas/OutreachPriorityFactor'
          type: array
          title: Priority Factors
          default: []
        language:
          anyOf:
            - type: string
            - type: 'null'
          title: Language
        blocked_reason:
          anyOf:
            - $ref: '#/components/schemas/OutreachRejectReason'
            - $ref: '#/components/schemas/OutreachBlockedReason'
            - type: 'null'
          title: Blocked Reason
        snooze_until:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Snooze Until
        next_resolution_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Next Resolution At
        owner_user_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Owner User Id
        owner_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Owner Name
        first_contacted_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: First Contacted At
        last_activity_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Activity At
        followup_count:
          type: integer
          title: Followup Count
          default: 0
        needs_decision:
          type: boolean
          title: Needs Decision
          default: false
        close:
          anyOf:
            - type: object
            - type: 'null'
          title: Close
        deal_terms:
          anyOf:
            - type: object
            - type: 'null'
          title: Deal Terms
        exchange:
          anyOf:
            - type: object
            - type: 'null'
          title: Exchange
        decision:
          anyOf:
            - type: object
            - type: 'null'
          title: Decision
        follow_up_blocked:
          anyOf:
            - type: string
            - type: 'null'
          title: Follow Up Blocked
        primary_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Primary Url
        primary_title:
          anyOf:
            - type: string
            - type: 'null'
          title: Primary Title
        url_count:
          type: integer
          title: Url Count
          default: 0
        citation_count:
          type: integer
          title: Citation Count
          default: 0
        platforms:
          items:
            type: string
          type: array
          title: Platforms
          default: []
        contact:
          anyOf:
            - $ref: '#/components/schemas/OutreachContactResponse'
            - type: 'null'
        prior_contact_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Prior Contact At
        prior_contact_email:
          anyOf:
            - type: string
            - type: 'null'
          title: Prior Contact Email
        prior_contact_replied:
          type: boolean
          title: Prior Contact Replied
          default: false
        stage:
          $ref: '#/components/schemas/OutreachStage'
          default: hikoo_working
        outcome:
          anyOf:
            - $ref: '#/components/schemas/OutreachOutcome'
            - type: 'null'
        stage_detail:
          $ref: '#/components/schemas/OutreachStageDetail'
          default: qualifying
        stage_detail_params:
          type: object
          title: Stage Detail Params
          default: {}
        waiting_days:
          anyOf:
            - type: integer
            - type: 'null'
          title: Waiting Days
        next_follow_up_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Next Follow Up At
        closed_reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Closed Reason
        with_you_until:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: With You Until
        paused_until:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Paused Until
        next_step:
          anyOf:
            - $ref: '#/components/schemas/OutreachNextStep'
            - type: 'null'
        close_reason:
          anyOf:
            - $ref: '#/components/schemas/OutreachCloseReason'
            - type: 'null'
        agent:
          anyOf:
            - $ref: '#/components/schemas/OutreachAgentPlanResponse'
            - type: 'null'
        urls:
          items:
            $ref: '#/components/schemas/OutreachSourceUrlResponse'
          type: array
          title: Urls
          default: []
        contacts:
          items:
            $ref: '#/components/schemas/OutreachContactResponse'
          type: array
          title: Contacts
          default: []
        messages:
          items:
            $ref: '#/components/schemas/OutreachMessageResponse'
          type: array
          title: Messages
          default: []
        timeline:
          items:
            $ref: '#/components/schemas/OutreachTouchResponse'
          type: array
          title: Timeline
          default: []
        placements:
          items:
            $ref: '#/components/schemas/OutreachPlacementResponse'
          type: array
          title: Placements
          default: []
        measurement_baseline:
          anyOf:
            - type: object
            - type: 'null'
          title: Measurement Baseline
        placement_watch_until:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Placement Watch Until
        prior_contact_thread_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Prior Contact Thread Id
        prior_contact_scanned_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Prior Contact Scanned At
        agent_drafting:
          type: boolean
          title: Agent Drafting
          default: false
        draft_failed:
          type: boolean
          title: Draft Failed
          default: false
        negotiation_ceiling:
          anyOf:
            - type: string
            - type: 'null'
          title: Negotiation Ceiling
        negotiation_currency:
          anyOf:
            - type: string
            - type: 'null'
          title: Negotiation Currency
        negotiation_note:
          anyOf:
            - type: string
            - type: 'null'
          title: Negotiation Note
        negotiation_set_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Negotiation Set At
        negotiation_offers:
          type: integer
          title: Negotiation Offers
          default: 0
        follow_up_plan:
          anyOf:
            - $ref: '#/components/schemas/OutreachFollowUpPlanResponse'
            - type: 'null'
        handed_from_email:
          anyOf:
            - type: string
            - type: 'null'
          title: Handed From Email
        handed_from:
          anyOf:
            - type: string
            - type: 'null'
          title: Handed From
        must_continue:
          type: boolean
          title: Must Continue
          default: false
        contact_research_allowed:
          type: boolean
          title: Contact Research Allowed
          default: false
        first_mail_rewrite_allowed:
          type: boolean
          title: First Mail Rewrite Allowed
          default: false
        first_mail_rewrite_pending:
          type: boolean
          title: First Mail Rewrite Pending
          default: false
        first_mail_outdated:
          type: boolean
          title: First Mail Outdated
          default: false
      type: object
      required:
        - id
        - domain
        - status
        - status_set_by
      title: OutreachSourceDetail
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    OutreachStatus:
      type: string
      enum:
        - eligible
        - rejected
        - contact_pending
        - contact_unresolved
        - draft_ready
        - awaiting_approval
        - contacted
        - replied
        - needs_human
        - in_discussion
        - no_reply
        - declined
        - placed
        - stopped
        - blacklisted
        - snoozed
      title: OutreachStatus
    OutreachActor:
      type: string
      enum:
        - agent
        - user
      title: OutreachActor
    OutreachPriorityFactor:
      properties:
        key:
          type: string
          title: Key
        points:
          type: integer
          title: Points
        max:
          type: integer
          title: Max
      type: object
      required:
        - key
        - points
        - max
      title: OutreachPriorityFactor
    OutreachRejectReason:
      type: string
      enum:
        - own_domain
        - competitor
        - suggested_competitor
        - major_platform
        - directory
        - already_mentioned
        - not_actionable
        - blacklisted
        - recently_contacted
        - no_usable_url
        - outside_si_window
        - not_relevant
        - page_gone
        - refused_in_workspace
        - rival_vendor
        - below_citation_floor
        - listed_nothing_to_correct
        - listed_only_generic_asks
        - page_unreachable
        - draft_breaks_rules
        - not_selected_by_triage
        - page_blocked
        - page_no_text
        - test_based_no_offer
        - review_aggregator
        - head_to_head_comparison
        - single_product_review
        - language_unsupported
        - category_mismatch
        - market_mismatch
        - follow_up_limit
        - no_answerable_criterion
        - stale_page
        - vendor_page
        - sponsored_page
        - agent_not_fit
      title: OutreachRejectReason
    OutreachBlockedReason:
      type: string
      enum:
        - fetch_failed
        - no_named_person
        - no_target_url
        - no_address
        - no_email
        - generic_address
        - solo_inbox
        - low_confidence
        - missing_full_name
        - address_inferred
        - address_from_provider
        - address_off_domain
        - email_unknown
        - email_risky
        - email_invalid
        - unresolved
        - stopped_citing
        - delivery_refused
      title: OutreachBlockedReason
    OutreachContactResponse:
      properties:
        id:
          type: integer
          title: Id
        is_alternate:
          type: boolean
          title: Is Alternate
          default: false
        full_name:
          type: string
          title: Full Name
        role_title:
          anyOf:
            - type: string
            - type: 'null'
          title: Role Title
        email:
          anyOf:
            - type: string
            - type: 'null'
          title: Email
        linkedin_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Linkedin Url
        confidence:
          type: number
          title: Confidence
          default: 0
        email_verified:
          type: boolean
          title: Email Verified
          default: false
        verification_result:
          $ref: '#/components/schemas/OutreachEmailVerification'
          default: unknown
        is_generic:
          type: boolean
          title: Is Generic
          default: false
        job_title:
          anyOf:
            - type: string
            - type: 'null'
          title: Job Title
      type: object
      required:
        - id
        - full_name
      title: OutreachContactResponse
    OutreachStage:
      type: string
      enum:
        - needs_you
        - hikoo_working
        - waiting
        - closed
      title: OutreachStage
    OutreachOutcome:
      type: string
      enum:
        - won
        - lost
        - disqualified
      title: OutreachOutcome
    OutreachStageDetail:
      type: string
      enum:
        - hot_reply_money
        - hot_reply
        - delivery_refused
        - taken_by_you
        - approve_pitch
        - approve_reply
        - approve_follow_up
        - decision
        - qualifying
        - finding_person
        - writing_pitch
        - waiting_to_search
        - waiting_to_write
        - contact_quota_reached
        - waiting_reply
        - follow_up_due
        - followed_up
        - waiting_to_connect
        - in_discussion
        - snoozed
        - awaiting_publication
        - with_you_until
        - paused_until
        - queued_to_send
        - no_person_yet
        - no_person_last_look
        - mention_online
        - they_declined
        - lost_paid_only
        - do_not_contact
        - no_reply
        - you_stopped
        - disqualified
      title: OutreachStageDetail
    OutreachNextStep:
      properties:
        who:
          $ref: '#/components/schemas/OutreachNextActor'
        what:
          type: string
          title: What
        params:
          type: object
          title: Params
          default: {}
      type: object
      required:
        - who
        - what
      title: OutreachNextStep
    OutreachCloseReason:
      properties:
        family:
          $ref: '#/components/schemas/OutreachCloseFamily'
        code:
          type: string
          title: Code
        by:
          $ref: '#/components/schemas/OutreachCloseBy'
        text:
          anyOf:
            - type: string
            - type: 'null'
          title: Text
        params:
          type: object
          title: Params
          default: {}
      type: object
      required:
        - family
        - code
        - by
      title: OutreachCloseReason
    OutreachAgentPlanResponse:
      properties:
        next_kind:
          anyOf:
            - $ref: '#/components/schemas/AgentNextKind'
            - type: 'null'
        next_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Next At
        why:
          anyOf:
            - type: string
            - type: 'null'
          title: Why
        decisions:
          items:
            $ref: '#/components/schemas/OutreachFounderDecisionLine'
          type: array
          title: Decisions
          default: []
      type: object
      title: OutreachAgentPlanResponse
    OutreachSourceUrlResponse:
      properties:
        id:
          type: integer
          title: Id
        url:
          type: string
          title: Url
        title:
          anyOf:
            - type: string
            - type: 'null'
          title: Title
        citation_count:
          type: integer
          title: Citation Count
          default: 0
        platforms:
          items:
            type: string
          type: array
          title: Platforms
          default: []
        queries:
          items:
            type: string
          type: array
          title: Queries
          default: []
        prompt_ids:
          items:
            type: integer
          type: array
          title: Prompt Ids
          default: []
        published_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Published At
        first_seen_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: First Seen At
        last_seen_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Seen At
        editorial_weight:
          type: number
          title: Editorial Weight
          default: 0
        is_primary_target:
          type: boolean
          title: Is Primary Target
          default: false
        author:
          anyOf:
            - type: string
            - type: 'null'
          title: Author
        competitors_on_page:
          items:
            type: string
          type: array
          title: Competitors On Page
          default: []
        page_competitors:
          anyOf:
            - $ref: '#/components/schemas/PageCompetitorsResponse'
            - type: 'null'
      type: object
      required:
        - id
        - url
      title: OutreachSourceUrlResponse
    OutreachMessageResponse:
      properties:
        id:
          type: integer
          title: Id
        channel:
          $ref: '#/components/schemas/OutreachChannel'
          default: email
        sequence_position:
          type: integer
          title: Sequence Position
        direction:
          $ref: '#/components/schemas/OutreachMessageDirection'
        subject:
          type: string
          title: Subject
        body:
          type: string
          title: Body
        language:
          anyOf:
            - type: string
            - type: 'null'
          title: Language
        status:
          $ref: '#/components/schemas/OutreachMessageStatus'
        scheduled_for:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Scheduled For
        sent_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Sent At
        gmail_thread_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Gmail Thread Id
        sender_email:
          anyOf:
            - type: string
            - type: 'null'
          title: Sender Email
        sender_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Sender Name
        edited_by_human:
          type: boolean
          title: Edited By Human
          default: false
        edited_by_user_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Edited By User Id
        approved_by_user_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Approved By User Id
        failure_reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Failure Reason
        signature:
          anyOf:
            - type: string
            - type: 'null'
          title: Signature
        version:
          type: integer
          title: Version
          default: 1
        version_position:
          type: integer
          title: Version Position
          default: 1
        version_count:
          type: integer
          title: Version Count
          default: 1
        changed_span:
          anyOf:
            - type: object
            - type: 'null'
          title: Changed Span
        written_in:
          anyOf:
            - type: string
            - type: 'null'
          title: Written In
        linkedin_part:
          anyOf:
            - type: string
            - type: 'null'
          title: Linkedin Part
        separate:
          type: boolean
          title: Separate
          default: false
        reading:
          anyOf:
            - $ref: '#/components/schemas/OutreachReplyReadingResponse'
            - type: 'null'
        held:
          type: boolean
          title: Held
          default: false
        agent_reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Agent Reason
        sent_without_asking:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Sent Without Asking
        agent_work_kind:
          anyOf:
            - type: string
            - type: 'null'
          title: Agent Work Kind
      type: object
      required:
        - id
        - sequence_position
        - direction
        - subject
        - body
        - status
      title: OutreachMessageResponse
    OutreachTouchResponse:
      properties:
        id:
          type: integer
          title: Id
        type:
          $ref: '#/components/schemas/OutreachTouchType'
        payload:
          anyOf:
            - type: object
            - type: 'null'
          title: Payload
        note:
          anyOf:
            - type: string
            - type: 'null'
          title: Note
        actor:
          $ref: '#/components/schemas/OutreachActor'
        actor_user_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Actor User Id
        actor_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Actor Name
        occurred_at:
          type: string
          format: date-time
          title: Occurred At
      type: object
      required:
        - id
        - type
        - actor
        - occurred_at
      title: OutreachTouchResponse
    OutreachPlacementResponse:
      properties:
        id:
          type: integer
          title: Id
        url:
          anyOf:
            - type: string
            - type: 'null'
          title: Url
        detected_at:
          type: string
          format: date-time
          title: Detected At
        detection_method:
          $ref: '#/components/schemas/OutreachPlacementMethod'
        snippet:
          anyOf:
            - type: string
            - type: 'null'
          title: Snippet
        si_state_applied:
          $ref: '#/components/schemas/OutreachSourceState'
        cited_confirmed_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Cited Confirmed At
        deliverable_type:
          anyOf:
            - $ref: '#/components/schemas/OutreachDeliverableType'
            - type: 'null'
        delivered_on:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Delivered On
      type: object
      required:
        - id
        - detected_at
        - detection_method
        - si_state_applied
      title: OutreachPlacementResponse
    OutreachFollowUpPlanResponse:
      properties:
        upcoming:
          items:
            type: string
            format: date-time
          type: array
          title: Upcoming
          default: []
        first_number:
          type: integer
          title: First Number
          default: 1
        ceiling:
          type: integer
          title: Ceiling
          default: 0
        closes_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Closes At
      type: object
      title: OutreachFollowUpPlanResponse
    Error:
      type: object
      title: Error
      required:
        - detail
      properties:
        detail:
          type: string
          description: Human-readable explanation of the error.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    OutreachEmailVerification:
      type: string
      enum:
        - valid
        - risky
        - invalid
        - unknown
      title: OutreachEmailVerification
    OutreachNextActor:
      type: string
      enum:
        - you
        - hikoo
        - them
        - nobody
      title: OutreachNextActor
    OutreachCloseFamily:
      type: string
      enum:
        - won
        - no_reply
        - declined
        - paid_only
        - do_not_contact
        - stopped_by_you
        - already_mentioned
        - not_a_fit
        - competitor
        - no_one_to_ask
        - page_unavailable
        - not_cited_enough
        - no_contact
        - out_of_scope
        - other
      title: OutreachCloseFamily
    OutreachCloseBy:
      type: string
      enum:
        - hikoo
        - you
        - them
      title: OutreachCloseBy
    AgentNextKind:
      type: string
      enum:
        - follow_up
        - look_again
        - send
        - asks_you
        - paused
        - with_you
        - working
      title: AgentNextKind
    OutreachFounderDecisionLine:
      properties:
        decision_id:
          type: integer
          title: Decision Id
        text:
          type: string
          title: Text
        decided_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Decided At
        by_user_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: By User Id
        by_name:
          anyOf:
            - type: string
            - type: 'null'
          title: By Name
      type: object
      required:
        - decision_id
        - text
      title: OutreachFounderDecisionLine
    PageCompetitorsResponse:
      properties:
        status:
          $ref: '#/components/schemas/OutreachPageReadStatus'
          default: unknown
        read_at:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Read At
        competitors:
          items:
            $ref: '#/components/schemas/PageCompetitorResponse'
          type: array
          title: Competitors
          default: []
        brand_on_page:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Brand On Page
        brand_position:
          anyOf:
            - type: integer
            - type: 'null'
          title: Brand Position
      type: object
      title: PageCompetitorsResponse
    OutreachChannel:
      type: string
      enum:
        - email
        - linkedin
      title: OutreachChannel
    OutreachMessageDirection:
      type: string
      enum:
        - outbound
        - inbound
      title: OutreachMessageDirection
    OutreachMessageStatus:
      type: string
      enum:
        - draft
        - awaiting_approval
        - approved
        - scheduled
        - sending
        - sent
        - failed
        - cancelled
      title: OutreachMessageStatus
    OutreachReplyReadingResponse:
      properties:
        intent:
          type: string
          title: Intent
        related:
          type: boolean
          title: Related
          default: true
        needs_answer:
          type: boolean
          title: Needs Answer
          default: true
        summary:
          type: string
          title: Summary
          default: ''
        asks:
          items:
            type: string
          type: array
          title: Asks
        choices:
          items:
            $ref: '#/components/schemas/OutreachHandoverChoiceResponse'
          type: array
          title: Choices
        price:
          anyOf:
            - type: string
            - type: 'null'
          title: Price
        currency:
          anyOf:
            - type: string
            - type: 'null'
          title: Currency
        price_buys:
          type: string
          title: Price Buys
          default: ''
      type: object
      required:
        - intent
      title: OutreachReplyReadingResponse
    OutreachTouchType:
      type: string
      enum:
        - qualified
        - new_url_detected
        - contact_resolved
        - contact_unresolved
        - contact_corrected
        - draft_generated
        - draft_edited
        - approved
        - sent
        - send_failed
        - status_changed
        - followup_sent
        - blacklisted
        - reply_received
        - handed_to_human
        - prior_contact_found
        - negotiation_authorised
        - offer_made
        - placement_detected
        - manual_note
      title: OutreachTouchType
    OutreachPlacementMethod:
      type: string
      enum:
        - crawl
        - manual
        - publisher_confirmed
        - founder_confirmed
        - url_provided
      title: OutreachPlacementMethod
    OutreachSourceState:
      type: string
      enum:
        - mentioned
        - cited
      title: OutreachSourceState
    OutreachDeliverableType:
      type: string
      enum:
        - web_page
        - newsletter
        - podcast
        - social_post
        - video
        - print
        - product_review
        - test_drive
        - other
      title: OutreachDeliverableType
    OutreachPageReadStatus:
      type: string
      enum:
        - fresh
        - stale
        - unknown
      title: OutreachPageReadStatus
    PageCompetitorResponse:
      properties:
        name:
          type: string
          title: Name
        position:
          anyOf:
            - type: integer
            - type: 'null'
          title: Position
      type: object
      required:
        - name
      title: PageCompetitorResponse
    OutreachHandoverChoiceResponse:
      properties:
        choice:
          $ref: '#/components/schemas/OutreachHotReplyAnswer'
        label:
          type: string
          title: Label
        consequence:
          type: string
          title: Consequence
          default: ''
        needs_amount:
          type: boolean
          title: Needs Amount
          default: false
      type: object
      required:
        - choice
        - label
      title: OutreachHandoverChoiceResponse
    OutreachHotReplyAnswer:
      type: string
      enum:
        - ask_their_price
        - offer_up_to
        - decline_politely
        - i_will_reply
        - ask_what_it_includes
        - accept_non_money_terms
        - answer_their_question
        - instruct_agent
      title: OutreachHotReplyAnswer
  responses:
    Unauthorized:
      description: >-
        The `Authorization` header is missing, malformed, or the key is invalid,
        expired or revoked.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            detail: Invalid or expired API key
    Forbidden:
      description: >-
        The key is valid but not allowed to do this: the website has no active
        subscription, your role in the workspace is read-only for a write
        request, or your email is not verified.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            detail: >-
              This website has no active subscription, so its data is
              unavailable.
      headers:
        X-Error-Code:
          description: >-
            Stable machine-readable error code, when one applies (for example
            `rate_limited`).
          schema:
            type: string
    NotFound:
      description: >-
        The website, or the resource in the path, does not exist or is not
        visible to this key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            detail: Website not found
    RateLimited:
      description: >-
        Too many requests for this API key. Wait for the number of seconds in
        `Retry-After`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            detail: Too many requests. Please try again shortly.
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
        X-Error-Code:
          description: >-
            Stable machine-readable error code, when one applies (for example
            `rate_limited`).
          schema:
            type: string
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: Personal API key created in the dashboard under Settings > API keys.

````

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