Add to an overlay's tip goal

Adjusts the goal’s progress by amount (negative subtracts) WITHOUT creating a tip - it rides 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_...) · headerrequired

A TipPage API key, created in Dashboard → Settings → Developer.

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

200Adjusted.

successboolean

addednumber

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

errorstringrequired

Human-readable message.

codestring

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

401Missing or invalid API key (`missing_api_key` / `invalid_api_key`).

errorstringrequired

Human-readable message.

codestring

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

403The key lacks the required scope (`missing_scope`).

errorstringrequired

Human-readable message.

codestring

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

required_scopestring

404No such resource.

errorstringrequired

Human-readable message.

codestring

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

429Rate limit exceeded - check the `RateLimit-*` headers.

errorstring

Request

curl -X POST "https://api.tippage.com/v1/overlays/o_1a2b3c4d/tip-goal/add" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": 25
}'

const response = await fetch("https://api.tippage.com/v1/overlays/o_1a2b3c4d/tip-goal/add", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "amount": 25
})
});

import requests

response = requests.post(
    "https://api.tippage.com/v1/overlays/o_1a2b3c4d/tip-goal/add",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
  "amount": 25
},
)

Response

{
  "success": true,
  "added": 25
}