Update an overlay's tip goal

Any subset of campaign fields. Changing them reloads the overlay’s browser source so the widget picks them up. Requires overlays:manage.

PATCH/overlays/{overlayId}/tip-goal

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

enabledboolean

titlestring

max length 80

amountnumber

min 0 · max 1000000

starts_atstring<date-time> | null

Count tips from this moment. Empty/null clears it.

ends_atstring<date-time> | null

Campaign end. Empty/null clears it.

Responses

200Updated.

successboolean

400Invalid amount or date.

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 PATCH "https://api.tippage.com/v1/overlays/o_1a2b3c4d/tip-goal" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "enabled": true,
  "title": "New PC fund",
  "amount": 500,
  "starts_at": "2019-08-24T14:15:22Z",
  "ends_at": "2019-08-24T14:15:22Z"
}'

const response = await fetch("https://api.tippage.com/v1/overlays/o_1a2b3c4d/tip-goal", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "enabled": true,
  "title": "New PC fund",
  "amount": 500,
  "starts_at": "2019-08-24T14:15:22Z",
  "ends_at": "2019-08-24T14:15:22Z"
})
});

import requests

response = requests.patch(
    "https://api.tippage.com/v1/overlays/o_1a2b3c4d/tip-goal",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
  "enabled": True,
  "title": "New PC fund",
  "amount": 500,
  "starts_at": "2019-08-24T14:15:22Z",
  "ends_at": "2019-08-24T14:15:22Z"
},
)

Response

{
  "success": true
}