List Async Actions

Async actions API lets you track asynchronous operations scheduled in your Projects. Using this endpoint you can list all async actions scheduled in your project.

{
    "object": "list",
    "data_ref": "async_actions",
    "async_actions": [
        {
            "id": "aa_09414733b84a1ed3c4",
            "type": "CAMPAIGN.VOUCHERS_IMPORT_CSV",
            "status": "DONE",
            "created_at": "2021-05-18T06:32:44.002Z",
            "object": "async_action"
        }
    ]
}

Response schema

In response, you'll get the list of all scheduled async actions and detailed information on each of them.

Response schema type: object

{
    "object": "list",// string
    "data_ref": "async_actions", // string
    "async_actions": [ // [object]
        {
            "id": "aa_09414733b84a1ed3c4", // string, unique id of the async action
            "type": "CAMPAIGN.VOUCHERS_IMPORT_CSV", // string, type of async action is different for each endpoint managed via async actions API
            "status": "DONE", // string, informs whether the async action is already completed
            "created_at": "2021-05-18T06:32:44.002Z", // string, date time of scheduling async action
            "object": "async_action" // string
        }
    ]
}

Note that status DONE doesn't include the result of the completed action. If you need more information about a result, use ID of the respective async action to call Get async actions.

Here's a list of endpoints that are handled using asynchronous operations.

CSV imports:

Purging metadata attributes from customer, product and vouches schema

Language
Response
Click Try It! to start a request and see the response here!