Run Bundle

POST /v1/tenants/{tenant_id}/data/run-bundle

go

Go

rr, err := client.Data.RunBundle(context.Background(), &v1.BundleRunRequest{
    TenantId: "t1",
    Name:     "organization_created",
    Arguments: map[string]string{
        "creatorID":      "564",
        "organizationID": "789",
    },
})

200

{
  "snap_token": "<string>"
}

The “Run Bundle” API provides a straightforward way to execute predefined bundles within your application’s tenant environment. By sending a POST request to this endpoint, you can activate specific functionalities or processes encapsulated in a bundle.

To see what Data Bundles are and how they work, check out the Data Bundles section.

Path Parameters

tenant_id · string · required

Identifier of the tenant, if you are not using multi-tenancy (have only one tenant) use pre-inserted tenant t1 for this field. Required, and must match the pattern \“[a-zA-Z0-9-,]+\“, max 64 bytes.

Body

application/json

BundleRunRequest is used to request the execution of a bundle. It includes tenant_id, the name of the bundle, and additional arguments for execution.

name · string

Name of the bundle to be executed.

arguments · object

Additional key-value pairs for execution arguments.

Show child attributes

Response

200

application/json

A successful response.

BundleRunResponse is the response for a BundleRunRequest. It includes a snap_token, which may be used for tracking the execution or its results.

snap_token · string

The snap token to avoid stale cache, see more details on Snap Tokens