Add or remove online time for many subscribers

POST /api/v1/users/bulk-add-time prm_users_add_traffic

Adds a signed number of minutes to each subscriber's remaining online time. A negative amount removes time and stops at zero.

A subscriber whose plan does not meter online time is reported as no_traffic_quota and left unchanged. bulk-add-traffic reports the same reason for a plan that does not meter traffic.

At a glance

Authentication: Staff token or session
Requires permission: prm_users_add_traffic Add traffic
Rate limit: t_mutate

Parameters

Parameter	Description
`ids`required body · array	Subscriber ids, at most 1000.
`params.minutes`required body · integer	Signed, non-zero minutes.

Request

curl -X POST "$BASE/api/v1/users/bulk-add-time" \
  -H "Authorization: Bearer $XR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "ids": [4711, 4712],
  "params": { "minutes": 60 }
}'

Response 200 OK

{
  "data": {
    "updated": [4711],
    "failed": [
      { "id": 4712, "reason": "no_traffic_quota",
        "message": "This subscriber's plan doesn't meter this — there is no balance to add to or take from." }
    ]
  }
}

BASE is your tenant host: the same address you sign in on.

Try it on your own network.

5000 subscribers for 90 days. You pay nothing.

Try it free Talk to us