RIripple
Omnibus

Update an omnibus structure

put/v1/domains/{domainId}/omnibus/{omnibusId}

Request

Path parameters

domainIdstring uuid required
omnibusIdstring uuid required

Request body

sponsoringGasStationIdstring uuid required

Entity ID of the Gas Station account that will sponsor fees for this omnibus account

Response

OK

idstring uuid required

Unique identifier of the omnibus structure

domainIdstring uuid required

Identifier of the domain this omnibus structure belongs to

custodyAccountIdstring uuid required

Identifier of the custody account backing this omnibus structure

aliasstring required

Alias of the omnibus structure

status'CREATING' | 'PENDING_SPONSORSHIP' | 'ACTIVE' | 'FAILED' required
lockStatus'UNLOCKED' | 'LOCKED' required
ignoredAccountIdsstring[] required

List of custody account IDs to ignore during event processing

createdAtstring date-time required

Timestamp when the omnibus structure was created

updatedAtstring date-time required

Timestamp when the omnibus structure was last updated

sponsoringGasStationIdstring uuid

Entity ID of the Gas Station account that sponsors fees for this omnibus account

Changes

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