Skip to main content

Favorite Script Configuration

This page documents the configuration parameters for the favorite script used in task creation.

Overview​

The favorite script adds a post to Favorites (on TikTok) / Saved (on Instagram). When you provide multiple target post URLs via API, one task is created per target post URL. You can control when each task executes using the start_time parameter.

Already-favorited posts are skipped

The script detects posts that are already favorited / saved and skips them, so re-running a task will not toggle a post back off.

Script Configuration (script_config)​

The script_config object contains the parameters for the favorite script. Below are the available parameters:

Parameters​

ParameterTypeRequiredDefaultDescription
target_post_urlsstring[]Yes*[]Array of target post URLs to favorite (one task per URL)
target_post_urlstringYes*""Single target post URL or multiple URLs separated by newlines/commas
note

Either target_post_urls array or target_post_url string must be provided. If both are provided, target_post_urls takes priority.

Task Creation

When multiple target post URLs are provided, the API creates one task per target post URL. For example, if you specify 3 post URLs and 2 devices, 6 tasks will be created. Use the start_time parameter to control when tasks start executing.

Examples​

Favorite a Single Post​

curl -X POST http://localhost:50809/api/v1/task \
  -H "Content-Type: application/json" \
  -d '{
    "serials": ["device_serial_1"],
    "script_name": "favorite",
    "script_config": {
      "target_post_url": "https://www.tiktok.com/@username/video/1234567890"
    }
  }'

Favorite Multiple Posts​

When favoriting multiple posts, one task is created per post:

curl -X POST http://localhost:50809/api/v1/task \
  -H "Content-Type: application/json" \
  -d '{
    "serials": ["device_serial_1"],
    "script_name": "favorite",
    "script_config": {
      "target_post_urls": [
        "https://www.tiktok.com/@user1/video/111",
        "https://www.tiktok.com/@user2/video/222",
        "https://www.tiktok.com/@user3/video/333"
      ]
    }
  }'

This creates 3 separate tasks that execute immediately.

Schedule Favorites with Start Time​

curl -X POST http://localhost:50809/api/v1/task \
  -H "Content-Type: application/json" \
  -d '{
    "serials": ["device_serial_1"],
    "script_name": "favorite",
    "script_config": {
      "target_post_url": "https://www.tiktok.com/@username/video/1234567890"
    },
    "start_time": "14:30"
  }'

Favorite Posts by Username List Mode​

Create favorite tasks directly for specific accounts:

curl -X POST http://localhost:50809/api/v1/task \
  -H "Content-Type: application/json" \
  -d '{
    "usernames": ["@my_account1", "@my_account2"],
    "script_name": "favorite",
    "script_config": {
      "target_post_url": "https://www.tiktok.com/@target/video/123"
    }
  }'

Instagram Save Example​

On Instagram the favorite script saves the post (bookmark):

curl -X POST http://localhost:50809/api/v1/task \
  -H "Content-Type: application/json" \
  -d '{
    "serials": ["device_serial_1"],
    "script_name": "favorite",
    "script_config": {
      "target_post_url": "https://www.instagram.com/p/ABC123/"
    }
  }'

Response​

{
  "code": 0,
  "message": "success",
  "data": {
    "task_ids": [601, 602, 603],
    "created_count": 3
  }
}

Post URL Formats​

TikTok​

https://www.tiktok.com/@username/video/1234567890123456
https://vm.tiktok.com/ABCDEFG/

Instagram​

https://www.instagram.com/p/ABCDEFGHIJK/
https://www.instagram.com/reel/ABCDEFGHIJK/

Best Practices​

  1. Schedule tasks: Use the start_time parameter to spread out actions over time, reducing the chance of rate limiting.

  2. Use multi-account mode: Enable enable_multi_account to favorite posts using multiple accounts on the same device.

Error Codes​

CodeDescription
40001Missing target post URL
40003Script not supported via API
40301API access requires Pro+ plan

See Also​