> ## 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.

# Apply a permission preset

> Fill the whole grid in one call. The locked square stays locked.



## OpenAPI

````yaml /api-reference/openapi.json put /api/v1/public/outreach/settings/preset
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/settings/preset:
    put:
      tags:
        - Outreach
      summary: Apply a permission preset
      description: Fill the whole grid in one call. The locked square stays locked.
      operationId: set_outreach_preset_api_v1_public_outreach_settings_preset_put
      parameters:
        - name: website_id
          in: query
          required: true
          schema:
            type: integer
            description: Target website id
            title: Website Id
          description: Target website id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OutreachPresetRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutreachSettingsResponse'
        '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:
    OutreachPresetRequest:
      properties:
        preset:
          $ref: '#/components/schemas/OutreachAutonomyPreset'
      type: object
      required:
        - preset
      title: OutreachPresetRequest
    OutreachSettingsResponse:
      properties:
        workspace_id:
          type: integer
          title: Workspace Id
        autonomy_preset:
          $ref: '#/components/schemas/OutreachAutonomyPreset'
        permissions:
          items:
            $ref: '#/components/schemas/OutreachPermissionSquare'
          type: array
          title: Permissions
          default: []
        money_max_per_mention:
          anyOf:
            - type: string
            - type: 'null'
          title: Money Max Per Mention
        money_max_per_month:
          anyOf:
            - type: string
            - type: 'null'
          title: Money Max Per Month
        currency:
          type: string
          title: Currency
          default: EUR
        follow_up_enabled:
          type: boolean
          title: Follow Up Enabled
          default: true
        follow_up_max:
          type: integer
          title: Follow Up Max
          default: 3
        linkedin_enabled:
          type: boolean
          title: Linkedin Enabled
          default: true
        follow_up_delay_days:
          type: integer
          title: Follow Up Delay Days
          default: 3
        onboarding_completed_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Onboarding Completed At
        offer:
          items:
            $ref: '#/components/schemas/OutreachOfferItem'
          type: array
          title: Offer
          default: []
        media:
          items:
            $ref: '#/components/schemas/OutreachMediaFile'
          type: array
          title: Media
          default: []
        sender_profile:
          anyOf:
            - $ref: '#/components/schemas/OutreachSenderProfile'
            - type: 'null'
        asks_you_first_count:
          type: integer
          title: Asks You First Count
          default: 0
        tells_you_after_count:
          type: integer
          title: Tells You After Count
          default: 0
        does_it_alone_count:
          type: integer
          title: Does It Alone Count
          default: 0
        agent_mode:
          type: boolean
          title: Agent Mode
          default: false
      type: object
      required:
        - workspace_id
        - autonomy_preset
      title: OutreachSettingsResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    OutreachAutonomyPreset:
      type: string
      enum:
        - asks_you_everything
        - follows_your_rules
        - runs_on_its_own
        - custom
      title: OutreachAutonomyPreset
    OutreachPermissionSquare:
      properties:
        kind:
          $ref: '#/components/schemas/OutreachWorkKind'
        level:
          $ref: '#/components/schemas/OutreachAutonomyLevel'
        locked:
          type: boolean
          title: Locked
          default: false
      type: object
      required:
        - kind
        - level
      title: OutreachPermissionSquare
    OutreachOfferItem:
      properties:
        kind:
          $ref: '#/components/schemas/OutreachOfferKind'
        detail:
          type: string
          maxLength: 1200
          title: Detail
          default: ''
      type: object
      required:
        - kind
      title: OutreachOfferItem
    OutreachMediaFile:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        content_type:
          type: string
          title: Content Type
        size:
          type: integer
          title: Size
        url:
          type: string
          title: Url
        created_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Created At
      type: object
      required:
        - id
        - name
        - content_type
        - size
        - url
      title: OutreachMediaFile
    OutreachSenderProfile:
      properties:
        relation:
          $ref: '#/components/schemas/OutreachSenderRelation'
        agency_name:
          anyOf:
            - type: string
              maxLength: 80
            - type: 'null'
          title: Agency Name
      type: object
      required:
        - relation
      title: OutreachSenderProfile
    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
    OutreachWorkKind:
      type: string
      enum:
        - find_opportunities
        - qualify_opportunity
        - find_person
        - research_person
        - write_pitch
        - send_pitch
        - send_follow_up
        - spot_hot_reply
        - answer_objection
        - accept_payment
      title: OutreachWorkKind
    OutreachAutonomyLevel:
      type: string
      enum:
        - asks_you_first
        - tells_you_after
        - does_it_alone
      title: OutreachAutonomyLevel
    OutreachOfferKind:
      type: string
      enum:
        - spokesperson
        - data
        - test_product
        - imagery
        - discount_or_trial
      title: OutreachOfferKind
    OutreachSenderRelation:
      type: string
      enum:
        - employee
        - agency
        - consultant
      title: OutreachSenderRelation
  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.