POST /v1/test_helpers/test_clocks/{test_clock}/advance

Starts advancing a test clock to a specified time in the future. Advancement is done when status changes to Ready.

Servers

Path parameters

Name Type Required Description
test_clock String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

Request body fields

Name Type Required Description
expand[] Array No

Specifies which fields in the response should be expanded.

frozen_time Integer Yes

The time to advance the test clock. Must be after the test clock's current frozen time. Cannot be more than two intervals in the future from the shortest subscription in this test clock. If there are no subscriptions in this test clock, it cannot be more than two years in the future.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.