RecomlyRecomlyRecomlyDocs
Recomly APIEndpoints

Adjust credit balance

Manually adjust an advocate's credit balance by a signed dollar amount.

POST /api/app/campaigns/{campaignId}/advocates/{advocateId}/credit

Adds or subtracts from an advocate's credit balance. Use for goodwill credits, corrections, or manual reward grants. The delta is in cents — positive increases the balance, negative decreases it.


Request

See API Basics for required headers.

Body

FieldTypeRequiredDescription
deltaintegerYesAmount in cents to add (positive) or subtract (negative). Must be non-zero. Maximum single adjustment: ±100,000 cents (±$1,000).
notestringNoOptional reason for the adjustment, shown in the activity log. Max 200 characters.

Sample request

curl -X POST https://api.recomly.com/api/app/campaigns/c7a3f1d2-84b0-4e9a-bcd2-1f3e5a7c9012/advocates/e9c5a3b1-72d4-4f8e-ace5-3g5h7i9j0123/credit \
  -H "Authorization: Bearer rk_live_abc123:def456" \
  -H "Content-Type: application/json" \
  -d '{
    "delta": 1000,
    "note": "Goodwill credit for referral campaign participation"
  }'

Sample response

Status: 200 OK

{
  "newBalanceCents": 3500
}

Error responses

See API Basics for standard status codes and error response format.

On this page

We use cookies

We use essential cookies to keep the site working, and optional analytics cookies to understand how it's used. Read our Privacy Policy.