Simulations

Freeze an account program

Changed on

Freezes an existing account program and the accounts under it. This endpoint is unavailable in live production.

post/v1/simulations/account_programs/{id}/freeze

Request

  • Base URL
    https://api.augustus.com
  • URL
    https://api.augustus.com/v1/simulations/account_programs/{id}/freeze
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

ID of the account program whose lifecycle is being simulated.

Headers

Idempotency-Keystring required

Idempotency key for safe retries. Reusing a key with an identical request body returns the cached response. Reusing a key with a different body returns 409.

Response

The account program freeze simulation acknowledgement

type'account_program_simulation' required

Resource type discriminator.

account_program_idstring uuid required

Account program whose lifecycle is being simulated.

Changes