Skip to content
TipPage Docs
Esc
↑↓navigate↵open⌘Jpreview

Add to an overlay's tip goal

Adjusts the goal’s progress by amount (negative subtracts) WITHOUT creating a tip - it uses a separate manual-adjustment offset that the dashboard’s reset-progress clears. The on-screen goal updates live, and a crossing into the target fires any goal-hit celebration. Requires overlays:manage.

POST/overlays/{overlayId}/tip-goal/add
Authorization
AuthorizationBearer token (tp_live_... or tpat_...) · headerrequired

A TipPage API key (tp_live_..., created in Dashboard → Settings → Developer) or an OAuth 2.0 access token (tpat_..., see the OAuth guide). Both carry the same scopes and are accepted on every endpoint.

Path parameters
overlayIdstringrequired

The overlay's id (o_ + 8 hex chars).

Request body
requiredapplication/json
amountnumberrequired

Non-zero; negative to subtract. Up to 1,000,000 either way.

Responses
200

Adjusted.

successboolean
addednumber
400

amount missing, zero, or out of range (invalid_amount).

errorstringrequired

Human-readable message.

codestring

Machine-readable code (e.g. missing_scope, not_in_queue).

401

Missing or invalid credential (missing_api_key / invalid_api_key, or invalid_token for an expired/revoked OAuth access token).

errorstringrequired

Human-readable message.

codestring

Machine-readable code (e.g. missing_scope, not_in_queue).

403

The key lacks the required scope (missing_scope).

errorstringrequired

Human-readable message.

codestring

Machine-readable code (e.g. missing_scope, not_in_queue).

required_scopestring
404

No such resource.

errorstringrequired

Human-readable message.

codestring

Machine-readable code (e.g. missing_scope, not_in_queue).

429

Rate limit exceeded - check the RateLimit-* headers.

errorstring
Try it
Server
Authorization
Parameters
Bodyapplication/json
Request
curl -X POST 'https://api.tippage.com/v1/overlays/o_1a2b3c4d/tip-goal/add' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "amount": 25
}'
Response
{
  "success": true,
  "added": 25
}