GMV Max

Sync specific spark codes to TikTok

Changed on

Synchronously authorise the listed spark codes against the shop's TikTok Business ad account. Each code fires one TikTok /tt_video/authorize/ call:

  • On success → code's sync_status flips to synced.
  • On TikTok QPS / rate-limit → code is left pending so the offline CRJ retries it; the response counts this in queued.
  • On hard error → failed with the error string.

Up to 100 codes per request. Shops without an active TikTok Business connection return 422 TIKTOK_NOT_CONNECTED. Single shop only.

post/gmv-max/spark-codes/sync

Request

  • Base URL
    https://api.reacherapp.com/public/v1
  • URL
    https://api.reacherapp.com/public/v1/gmv-max/spark-codes/sync
  • Auth
    API key in header x-api-key and API key in header x-shop-id

Headers

Idempotency-Keystring nullable
X-Dry-Runstring nullable

Request body

spark_codesstring[] required

Up to 100 spark codes to sync in one request. Each code fires one TikTok /tt_video/authorize/ call; rate-limited codes are left as pending so the offline CRJ picks them up. Whitespace is stripped; blank or duplicate entries are rejected with 422.

Response

Sync attempted; see results for per-code outcome.

syncedinteger required
failedinteger required
queuedinteger required

Changes

    • breaking

      the response's body type changed from no type to object for status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      api operation id sync_spark_codes_gmv_max_spark_codes_sync_post removed and replaced with gmv_max_spark_codes_sync