Account

Change a team key's cap or label

Cost: 0 credits. Set, change or remove one team key's monthly credit cap, and/or relabel it. The key string does not change and nothing needs redeploying.

{"monthly_cap": 5000} caps this key at 5,000 credits for the rest of this period — against the counter it has ALREADY spent, so lowering a cap below what a key has used this month refuses it until the 1st rather than rewriting history. {"monthly_cap": null} removes the cap and lets the key spend the whole pool. Leave a field out and it is not touched: {"label": "Jo's laptop"} alone renames the key and leaves its cap alone.

patch/v1/keys/team/{key_id}

Request

  • Base URL: https://api.puntersedge.online
  • URL: https://api.puntersedge.online/v1/keys/team/{key_id}
  • Auth: API key in header X-API-Key

Path parameters

key_idstring required

key_id from GET /v1/keys/team.

Headers

X-API-Keystring
X-RapidAPI-Proxy-Secretstring

Request body

labelstring nullable

New label for this key. Omit to leave it alone.

monthly_capinteger nullable

Optional. The most credits THIS key may spend per month, hard, inside the account's shared pool — between 1 and the plan's own monthly allowance. Omit it (or send null) and the key may spend the whole pool. Caps reset with the pool on the 1st. Send null to REMOVE an existing cap; omit the field entirely to leave the cap as it is.

Response

Successful Response

key_idstring required
key_hintstring required
labelstring nullable required
planstring required
created_atstring nullable
last_used_atstring nullable
period_callsinteger
period_creditsinteger
monthly_capinteger nullable

This key's hard per-month credit cap, or null for no cap.

key_credits_usedinteger

Credits charged against this key's own counter this period. That is the number the cap is checked against; it stays 0 on an uncapped team key, whose spending is only ever charged to the pool row. Use period_credits for what an uncapped key has spent.

Changes

No recorded changes to this operation across all 1 revision of this API.