Gas station

Update a sponsor configuration

put/v1/domains/{domainId}/account/{accountId}/sponsor

Request

Base URL
https://docs.ripple.com (the document declares no server; this is the origin it was published from)
Auth
HTTP bearer
TypeScript
https://skmtc.dev/ripple/apis/ripple-custody-api/docs/v1/domains/:domainId/account/:accountId/sponsor/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

domainIdstring required

Domain ID

accountIdstring required

Account ID

Request body

type'domain' | 'account' | 'none' required

Type of sponsorship

accountIdsstring[]

Array of account UUIDs to sponsor

includeSubDomainsboolean required

Include subdomains in sponsorship

userIdstring

UUID of the user performing the action; recorded on the audit trail. Optional — only honored when the caller is a service principal; otherwise the authenticated user from the JWT is used.

Response

Sponsor updated

typestring required

accountIdsstring[] required

includeSubDomainsboolean required

criticalCountnumber

Number of tickers in critical status. Omitted if balance fetch fails.

Changes

No recorded changes to this operation across all 3 revisions of this API.