Skip to main content

Profile Script Configuration

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

Overview​

The profile script is used to automatically update the profile of a TikTok or Instagram account. It can update the avatar, nickname, username, bio, and link URL.

Script Configuration (script_config)​

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

Parameters​

ParameterTypeRequiredDefaultDescription
usernamestringNo""The username of the account whose profile to update. Used in device-based mode.
avatars_pathstringNo""Path to a folder containing avatar images. Leave empty to skip avatar update.
nicknamestringNo""Single nickname to set. Takes priority over nicknames.
nicknamesstringNo""Multiple nicknames separated by newlines. One is selected based on profile_order.
username_tostringNo""New username to set. Takes priority over usernames.
usernamesstringNo""Multiple new usernames separated by newlines. One is selected based on profile_order.
biostringNo""Single bio text to set. Takes priority over bios.
biosstringNo""Multiple bio texts separated by newlines. One is selected based on profile_order.
link_urlstringNo""Single link URL to set. Takes priority over link_urls.
link_urlsstringNo""Multiple link URLs separated by newlines. One is selected based on profile_order.
profile_orderstringNo"random"How to select content when using multi-value fields: random or sequential.
job_countintegerNo0Job counter used for sequential selection. Automatically set by the system.
note

At least one of the profile fields (avatar, nickname, username_to, bio, link_url) should be provided. Otherwise the script will run but make no changes.

Examples​

Update Nickname​

curl -X POST http://localhost:50809/api/v1/task \
  -H "Content-Type: application/json" \
  -d '{
    "serials": ["device_serial_1"],
    "script_name": "profile",
    "script_config": {
      "username": "@my_account",
      "nickname": "My New Nickname"
    }
  }'
curl -X POST http://localhost:50809/api/v1/task \
  -H "Content-Type: application/json" \
  -d '{
    "serials": ["device_serial_1"],
    "script_name": "profile",
    "script_config": {
      "username": "@my_account",
      "bio": "Check out my latest content!",
      "link_url": "https://example.com"
    }
  }'

Update Avatar​

curl -X POST http://localhost:50809/api/v1/task \
  -H "Content-Type: application/json" \
  -d '{
    "serials": ["device_serial_1"],
    "script_name": "profile",
    "script_config": {
      "username": "@my_account",
      "avatars_path": "C:/avatars/"
    }
  }'

Update Multiple Accounts with Different Nicknames​

Use nicknames with profile_order: sequential to assign different nicknames across accounts:

curl -X POST http://localhost:50809/api/v1/task \
  -H "Content-Type: application/json" \
  -d '{
    "serials": ["device_serial_1", "device_serial_2", "device_serial_3"],
    "script_name": "profile",
    "script_config": {
      "nicknames": "Nickname One\nNickname Two\nNickname Three",
      "profile_order": "sequential",
      "bio": "Follow me for amazing content!"
    }
  }'

Update Profile by Username Mode​

curl -X POST http://localhost:50809/api/v1/task \
  -H "Content-Type: application/json" \
  -d '{
    "usernames": ["@account1", "@account2"],
    "script_name": "profile",
    "script_config": {
      "nickname": "New Brand Name",
      "bio": "Updated bio for all accounts",
      "link_url": "https://mybrand.com"
    }
  }'

Schedule Profile Update​

curl -X POST http://localhost:50809/api/v1/task \
  -H "Content-Type: application/json" \
  -d '{
    "serials": ["device_serial_1"],
    "script_name": "profile",
    "script_config": {
      "username": "@my_account",
      "nickname": "Updated Nickname",
      "bio": "Fresh content every day!"
    },
    "start_time": "10:00"
  }'

Response​

{
  "code": 0,
  "message": "success",
  "data": {
    "task_ids": [401, 402],
    "created_count": 2
  }
}

Profile Order​

Random Order (random)​

  • Randomly selects one value from multi-value fields (nicknames, bios, etc.)
  • Default behavior

Sequential Order (sequential)​

  • Selects values in order based on job_count
  • First task uses first value, second task uses second value, etc.
  • Cycles back to beginning when reaching the end
  • Good for assigning different values to different accounts

Error Codes​

CodeDescription
40001Missing required parameters
40003Script not supported via API
40301API access requires Pro+ plan

See Also​