Skip to main content
PUT
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the first answer with idempotentReplay: true.

Required string length: 8 - 255

Path Parameters

locationId
string
required

The sub-account's GoHighLevel Location ID.

Minimum string length: 1

Body

application/json

The setting.

enabled
boolean
required

Whether the sub-account tops itself up.

thresholdUSD
number

Top up when the dollar balance falls below this. Leave out to keep the stored value, or to take the platform default of $50 when the sub-account has never had one.

Required range: x >= 10
rechargeAmountUSD
number

Dollars each top-up charges the client's card. Leave out to keep the stored value, or to take the platform default of $200 when the sub-account has never had one. Name it rather than inheriting it: this is the figure a client is charged without being asked again.

Response

The sub-account after the change.

success
boolean
required
Example:

true

data
object
required
idempotentReplay
boolean

Present, and true, when this answer is a replay of an earlier request with the same Idempotency-Key.