Vault Epochs

Update a vault epoch

Update a vault epoch. Requires admin role for the vault's organization.

put/v3/vaults/{vaultId}/epochs/{epochId}

Request

  • Base URL: https://api.creditcoop.xyz
  • URL: https://api.creditcoop.xyz/v3/vaults/{vaultId}/epochs/{epochId}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://clerk.creditcoop.xyz/oauth/authorize, token URL https://clerk.creditcoop.xyz/oauth/token)

Path parameters

vaultIdstring uuid required
epochIdstring uuid required

Request body

epochNumberinteger
targetSizestring nullable
state'upcoming' | 'open' | 'closed'

On a state transition, opensAt/closesAt are set automatically to the server clock (opens_at when transitioning to 'open', closes_at when transitioning to 'closed') — they cannot be set directly.

Changes

No recorded changes to this operation across all 1 revision of this API.