Gas station

Add sponsored domains

post/v1/domains/{domainId}/account/{entityId}/sponsored-domains

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/:entityId/sponsored-domains/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

domainIdstring required

Sponsor domain ID

entityIdstring required

Sponsor account ID

Request body

userIdstring

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

Response

successboolean required

Whether the operation completed (true even for partial success)

countnumber required

Number of entities successfully added

Example response

{
  "conflicts": [
    {
      "reason": "ALREADY_SPONSORED"
    }
  ]
}

Changes

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