---
title: "Replace tracked items"
method: POST
path: "/api/crawl/settings"
tags: ["Crawl Settings"]
---

# Replace tracked items

`POST /api/crawl/settings`

## Request

- Base URL: `https://api.xpoz.ai`
- URL: `https://api.xpoz.ai/api/crawl/settings`
- Auth: HTTP bearer

Replace the caller's tracked items. Rejected when the plan limit is exceeded.

## Request body

- object
  - `items` CrawlSettings, required: Tracked items per platform.
    - `twitter` object
      - `keywords` TrackedKeyword[]
        - union
          - string
          - object
            - `value` string, required
            - `country` string
      - `users` string[]
    - `instagram` object
      - `keywords` TrackedKeyword[]
        - union
          - string
          - object
            - `value` string, required
            - `country` string
      - `users` string[]
    - `reddit` object
      - `keywords` TrackedKeyword[]
        - union
          - string
          - object
            - `value` string, required
            - `country` string
      - `subreddits` string[]
      - `users` string[]
    - `tiktok` object
      - `keywords` TrackedKeyword[]
        - union
          - string
          - object
            - `value` string, required
            - `country` string
      - `users` string[]
      - `hashtags` string[]

## Response `200`

Saved settings.

- CrawlSettingsRecord
  - `id` string, required
  - `tenantId` string, required
  - `userEmail` string, required
  - `items` CrawlSettings, required: Tracked items per platform.
    - `twitter` object
      - `keywords` TrackedKeyword[]
        - union
          - string
          - object
            - `value` string, required
            - `country` string
      - `users` string[]
    - `instagram` object
      - `keywords` TrackedKeyword[]
        - union
          - string
          - object
            - `value` string, required
            - `country` string
      - `users` string[]
    - `reddit` object
      - `keywords` TrackedKeyword[]
        - union
          - string
          - object
            - `value` string, required
            - `country` string
      - `subreddits` string[]
      - `users` string[]
    - `tiktok` object
      - `keywords` TrackedKeyword[]
        - union
          - string
          - object
            - `value` string, required
            - `country` string
      - `users` string[]
      - `hashtags` string[]
  - `frequencyMinutes` number, required
  - `lastCrawledAt` string, date-time, nullable
  - `createdAt` string, date-time, required
  - `updatedAt` string, date-time, nullable

## Other responses

- `400`: Query or body validation failed. `message` joins all validation issues with `, `.
- `401`: Missing or invalid credentials.
- `403`: Plan limit exceeded.
- `500`: Server error.

---

[API](https://skmtc.dev/xpoz/apis/xpoz-api.md) · [All operations](https://skmtc.dev/xpoz/apis/xpoz-api/llms.txt) · [OpenAPI document](https://skmtc.dev/xpoz/apis/xpoz-api/revisions/c18261f587a4?raw)