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

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_... 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
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
200

Updated.

successboolean
400

Invalid amount or date.

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 PATCH 'https://api.tippage.com/v1/overlays/o_1a2b3c4d/tip-goal' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -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"
}'
Response
{
  "success": true
}