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

# Update tracking

> Send only the fields to change. An empty body returns `400`. `status: paused` stops scheduled runs; `status: ok` resumes. Founders you resend keep their enriched data.



## OpenAPI

````yaml /openapi.json patch /api/v1/tracker/{id}
openapi: 3.1.0
info:
  title: RaiseGate Partner API
  version: 1.0.0
  description: >-
    Organisation-scoped API for managing tracker entities, reading signals and
    alerts, and reviewing generated leads. Every key belongs to one
    organisation. Send `Authorization: Bearer rg_live_...` on every request.
servers:
  - url: https://app.raisegate.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Tracker
    description: Companies and founders the organisation monitors.
  - name: Signals
    description: Analysed result of each tracker run.
  - name: Alerts
    description: Whether a run emailed the VC, and why.
  - name: Leads
    description: Founders discovered around tracked companies.
paths:
  /api/v1/tracker/{id}:
    patch:
      tags:
        - Tracker
      summary: Update tracking
      description: >-
        Send only the fields to change. An empty body returns `400`. `status:
        paused` stops scheduled runs; `status: ok` resumes. Founders you resend
        keep their enriched data.
      operationId: updateTrackedEntity
      parameters:
        - $ref: '#/components/parameters/EntityId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TrackerPatch'
            examples:
              pause:
                value:
                  status: paused
              alerts:
                value:
                  alertEmails:
                    - partners@fund.example
                  cadenceDays: 3
      responses:
        '200':
          $ref: '#/components/responses/TrackerEntity'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  parameters:
    EntityId:
      name: id
      in: path
      required: true
      schema:
        type: string
        format: uuid
  schemas:
    TrackerPatch:
      type: object
      properties:
        companyName:
          type: string
        companyWebsite:
          type: string
          format: uri
        companyLinkedinUrl:
          type:
            - string
            - 'null'
          format: uri
        companyTwitterUrl:
          type:
            - string
            - 'null'
          format: uri
        companyGithubUrl:
          type:
            - string
            - 'null'
          format: uri
        founders:
          type: array
          minItems: 1
          maxItems: 10
          description: >-
            Replaces the founder list. Existing founders are matched by id,
            LinkedIn URL, or name and keep enriched data.
          items:
            $ref: '#/components/schemas/Founder'
        thingsToTrack:
          type: string
        alertEmails:
          type: array
          items:
            type: string
            format: email
        emailAlertsEnabled:
          type: boolean
        cadenceDays:
          type: integer
          enum:
            - 3
            - 7
            - 30
        status:
          type: string
          enum:
            - ok
            - paused
        tags:
          type: array
          maxItems: 20
          description: 'Normalised: trimmed, lower-cased, de-duplicated and sorted.'
          items:
            type: string
    Founder:
      type: object
      required:
        - name
      properties:
        id:
          type: string
          description: 'PATCH only: stored founder id to update in place.'
        name:
          type: string
        linkedinUrl:
          type: string
          format: uri
        twitterUrl:
          type: string
          format: uri
        githubUrl:
          type: string
          format: uri
    TrackerEntityEnvelope:
      type: object
      properties:
        data:
          type: object
        operation:
          $ref: '#/components/schemas/Operation'
        idempotencyReplayed:
          type: boolean
        existingEntity:
          type: boolean
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type: object
    Operation:
      type: object
      properties:
        entityId:
          type: string
          format: uuid
        pollUrl:
          type: string
        enrichmentStatus:
          type: string
          enum:
            - queued
            - running
            - ready
            - partial
            - failed
        enrichmentComplete:
          type: boolean
        suggestedPollIntervalSeconds:
          type:
            - integer
            - 'null'
  responses:
    TrackerEntity:
      description: Tracked company plus enrichment operation.
      headers:
        Location:
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/TrackerEntityEnvelope'
    BadRequest:
      description: '`validation_error`, `invalid_json`, or `invalid_cursor`.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: >-
        Missing, malformed, unknown, revoked or expired key, or a key not tied
        to a member of its organisation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Key lacks the required scope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Unknown ID, or an ID from another organisation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: Per-key rate limit exceeded. Wait `Retry-After` seconds.
      headers:
        Retry-After:
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: RaiseGate API key
      description: >-
        API key issued with `npm run partner-api:key -- --org <slug> --user
        <member-email> --name <name>`. Format: `rg_live_...`. The key acts for
        that member of the organisation; keys of `viewer` members are read-only.

````