Run a load

Allows to manually run data load into customer’s destination. Optionally provide date_from and date_to in the request body to run the load for a specific date range. Both fields must be provided together. Date range is ignored for loads by accounts.

put/api/v3/loads/{id}/run

Request

Base URL
https://embedded.improvado.io
Auth
none declared
TypeScript
https://skmtc.dev/improvado/apis/improvado-embedded-api-v3/docs/api/v3/loads/:id/run/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idinteger required

Load ID

Request body

date_fromstring date

Start date for the load run (YYYY-MM-DD). Must be used together with date_to.

date_tostring date

End date for the load run (YYYY-MM-DD). Must be used together with date_from.

Example request

{
  "date_from": "2024-01-01",
  "date_to": "2024-01-31"
}

Response

Run a Load

Changes

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