Update Wallet

Changes a wallet's name, Limit, notification threshold, external ID or active state.

Changes a wallet. Send only the fields to change.

API syntax

PUT https://api.kevel.co/v1/wallet/{WalletID}

Effects

  • Raising Limit lets linked Campaigns spend more.
  • Lowering Limit to the Balance or below caps the wallet.
  • Setting IsActive to false stops every linked Campaign.

Changes take a short delay to reach serving.

Fixed fields

Currency and the Balance cannot be changed here. A request with Currency, or any field the endpoint does not accept, returns 400. To change the Balance, post an adjustment.

Errors

StatusMessageWhat to do
400Object contains unrecognized key(s) … at …Remove the field.
400Wallet {id} not found.Use one of your wallet IDs. This endpoint returns 400, not 404.
Path Params
integer
required

The wallet's ID.

Body Params
string
length ≤ 200

The wallet's name.

integer

The Balance at which linked Campaigns stop. A whole number in the wallet's currency. It can be positive, zero or negative.

integer | null

Kevel Console shows the Low status and sends a notification when Available (Limit minus the Balance) is at or below this. Ad serving ignores it. Omitted when not set.

string | null

Your own reference for the wallet, such as a purchase order number. Omitted when not set.

boolean

false stops spend on every linked Campaign, whatever the Balance.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json