API Referencefarm-profiles

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

X-API-Keystring
API Key authentication via header

Path parameters

profile_idstringRequiredformat: "uuid"

Request

This endpoint expects an object.
biostring or nullOptional

New account bio/about text to set on the profile. Omit to leave unchanged.

profile_picture_urlstring or nullOptional
HTTPS URL of a new image to set as the account's profile picture. Omit to leave unchanged.

Response

Successful Response
profile_idstring
Unique profile identifier.
profile_namestring

Internal display name for the profile. Set via account_name at creation; defaults to username.

tiktok_usernamestring

The TikTok handle linked to this profile. Mutable — may change if the handle is renamed on TikTok.

created_atdatetime or null

Profile creation time as an ISO-8601 timestamp (UTC). null until provisioning records it.

phone_idstring or null

Cloud-phone identifier hosting this profile.

statusenumDefaults to configuring

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 to warm when it finishes.
  • warm — resting state during the warmup phase (a ~1-week schedule of warmup tasks), between runs. Not postable and not terminal — oscillates with warming until enough runs complete.
  • ready — at least 7 successful warmup tasks have completed over a span of at least 7 days; the profile is now postable. Maintenance warmups may still cycle it back through warming and return it to ready.
  • failed — recovery exhausted; this profile won’t be salvaged. Terminal. Create a new profile to try again.
  • deactivated — profile is no longer active. Terminal.

Transitions: configuring → cold → warming ↔ warm → ready. Once ready, maintenance runs flip it through warming and back to ready. configuring may pass through retrying and back, or terminate at failed. Any state can transition to deactivated.

platformslist of strings or null

Two-element array: [social_platform, email_auth_method]. Always ['tiktok', 'google'] or ['tiktok', 'outlook'].

biostring or null

Account bio/about text set on the profile. null until the phone is provisioned, or if none was provided at creation.

profile_picture_urlstring or null

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.

accountslist of objects

Platform accounts on this phone (TikTok plus its linked email). Empty array until the phone is provisioned.

Errors

400
Bad Request Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error