API reference / Connected sessions / Collect sound

Collect sound

Save or unsave a sound on an authorized Enterprise session.

POSTapi.tikultra.com/v1/account/music/collect15 credits

Authorization & parameters

x-api-keyheader · stringrequired

Your API key. Create one in API keys.

Send JSON with content-type: application/json.

account_idstringrequired

A connected account, from /dash/sessions or POST /v1/account/import. For example acc_7Hq2.

music_idstringrequired

The numeric sound ID. For example 7569924403851462401.

actioninteger

1 to collect, 0 to uncollect. For example 1.

Executes on the dedicated FullPool mobile context and city-level egress bound to account_id. See Connected sessions.

A 200 returns JSON with stable field names. Every response carries x-credits-cost, x-credits-tier and x-credits-remaining.

Key top-level and nested fields decoded from the mobile upstream payload:

status_codeinteger

Upstream TikTok mobile status code (0 indicates success).

account_idstring

Connected session identifier bound to a dedicated FullPool mobile context.

music_idstring

Unique music identifier.

actioninteger

Decoded action value.

collectedboolean

Whether collected is enabled or true.

log_pbobject

Upstream request trace envelope from the mobile gateway.

log_pb.impr_idstring

Upstream TikTok impression / trace identifier.

Errors return a JSON body with a stable code and cost 0 credits. See Errors and retries.

Accounts you own only. Connected sessions are for accounts you own or are authorized to operate. Available on Growth and Scale.

Enterprise only. This endpoint is enabled per contract for authorized accounts. Talk to us.