Update a farm profile
Updates the bio and/or profile_picture_url stored for a farm profile. Provide either or both; omitted fields are left unchanged.
Rate limit: 30 requests per minute per team.
Authentication
Path parameters
Request
New account bio/about text to set on the profile. Omit to leave unchanged.
Response
Internal display name for the profile. Set via account_name at creation; defaults to username.
The TikTok handle linked to this profile. Mutable β may change if the handle is renamed on TikTok.
Profile creation time as an ISO-8601 timestamp (UTC). null until provisioning records it.
Cloud-phone identifier hosting this profile.
Lifecycle status of the profile.
configuringβ phone is being provisioned and the social account is being set up.retryingβ initial setup hit a snag; weβre auto-recovering on the backend. No action needed.coldβ accounts are logged in but lack the history needed to start posting; no warmup runs have happened yet.warmingβ a warmup task is actively running on the phone (~15β30 minutes). Returns towarmwhen it finishes.warmβ resting state during the warmup phase (a ~3-day schedule of warmup tasks), between runs. Not postable and not terminal β oscillates withwarminguntil enough runs complete.readyβ at least 3 successful warmup tasks have completed over a span of at least 3 days; the profile is now postable. Maintenance warmups may still cycle it back throughwarmingand return it toready.following: a follow task is actively running on the phone. Transient; returns to its prior resting state (cold/warm/ready) when it finishes.posting: a post is actively uploading/publishing on the phone. Transient; returns to its prior resting state when it finishes.failedβ recovery exhausted; this profile wonβt be salvaged. Terminal. Create a new profile to try again.deactivatedβ profile is no longer active. Terminal.bannedβ the platform banned the account. Terminal. The profile stays in your records but is removed from your monthly billing quantity, with prorated credits applied for the unused portion of the month.
Transitions: configuring β cold β warming β warm β ready. Once ready, maintenance runs flip it through warming and back to ready. following and posting are transient busy states any active profile can briefly enter and then leave. configuring may pass through retrying and back, or terminate at failed. Any state can transition to deactivated or banned.
Number of successful warmup runs completed so far. null until the phone is provisioned. Compare against warmups_required to gauge progress toward ready.
Successful warmup runs required, spanning at least 3 days, before the profile becomes ready.
ISO-8601 timestamp (UTC) of the most recent warmup run. null before the first run.
Two-element array: [social_platform, auth_method], e.g. ['tiktok', 'sms'] (default), ['tiktok', 'google'], or ['tiktok', 'outlook'].
Account bio/about text set on the profile. null until the phone is provisioned, or if none was provided at creation.
HTTPS URL of the image set as the accountβs profile picture. null until the phone is provisioned, or if none was provided at creation.
Platform accounts on this phone (TikTok, plus its linked email for email-backed accounts). Empty array until the phone is provisioned.