REreacherapp
Automations

Outreach send capacity for this shop

Changed on

Current outreach send-capacity for a single shop, so callers can pre-check before sending TC invites / DMs and schedule retries when capacity frees.

Two independent limits govern outreach:

  • Daily per-shop throttle counted in UTC (resets at 00:00 UTC — see daily_window_resets_at). daily_creators_used counts actual sends only (skipped/creator_not_found invites do not count). The daily ceiling is plan/TikTok-dependent and is not returned as a single number; daily_limit_throttled flags when the shop is currently paused by it.
  • TikTok's outreach quota, enforced TikTok-side and read from TikTok's own quota endpoint — see outreach_quota for the consumption, ceiling and refresh instant. It counts connections shop-wide, so it includes outreach not sent through Reacher. Most shops are on a weekly PERIOD quota; some hold a BONUS grant that does not roll, so check outreach_quota.quota_type before calling it weekly. Null when the shop has no synced quota — null means unknown, never zero. weekly_limit_throttled flags when paused by the limit.

The daily pool is shared between the automation engine and direct POST /target-collabs invites. Requires a single shop.

get/automations/outreach-capacity

Request

  • Base URL
    https://api.reacherapp.com/public/v1
  • URL
    https://api.reacherapp.com/public/v1/automations/outreach-capacity
  • Auth
    API key in header x-api-key and API key in header x-shop-id

Response

Successful Response

shop_idinteger required
daily_creators_usedinteger required

Distinct (creator, automation) outreach sends counted for this shop in the current UTC day. Counts actual sends only — invites that were skipped (e.g. creator_not_found) do not count.

daily_window_resets_atstring required

ISO-8601 UTC timestamp of the next daily-window reset (next 00:00 UTC).

concurrent_automations_runninginteger required

Outreach automations currently in a running/paused-but-live state.

max_concurrent_automationsinteger required

Plan ceiling for concurrent automations.

daily_limit_throttledboolean required

True when a live automation is currently paused by the daily outreach limit.

weekly_limit_throttledboolean required

True when a live automation is currently paused by TikTok's weekly outreach limit. When true, daily capacity is moot until the weekly window resets.

Changes

  • 10090480c809Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 291230805105Revision changes
    • info

      api operation id automation_outreach_capacity_automations_outreach_capacity_get removed and replaced with automation_outreach_capacity