Skip to main content
POST
/
v1
/
tenants
/
{tenant_id}
/
data
/
run-bundle
go
rr, err := client.Data.RunBundle(context.Background(), &v1.BundleRunRequest{
    TenantId: "t1",
    Name:     "organization_created",
    Arguments: map[string]string{
        "creatorID":      "564",
        "organizationID": "789",
    },
})
client.data.runBundle({
    tenantId: "t1",
    name: "organization_created",
    arguments: {
        creatorID: "564",
        organizationID: "789",
    }
}).then((response) => {
    // handle response
})
curl --location --request POST 'localhost:3476/v1/tenants/{tenant_id}/data/run-bundle' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "organization_created",
    "arguments": {
        "creatorID": "564",
        "organizationID": "789"
    }
}'
{
  "snap_token": "<string>"
}
{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "<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.

Response

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