Isolate inboxes by tenant, client, or agent using namespaces. Use an external ID to map namespaces to your own data model.
Summary
Functions
Create Namespace
Delete Namespace
List Namespace Inboxes
List Namespaces
Retrieve Namespace
Update Namespace
Functions
Create Namespace
Create a new namespace.
Arguments
client— ANuntly.Clientreturned byNuntly.new/1.body— application/json request body usingCreateNamespaceRequest. Accepted fields:"name"(string, required) — The display name of the namespace."externalId"(string, optional) — An optional external identifier for the namespace.
opts— Optional keyword list passed to Req for this request.
Example
client = Nuntly.new(api_key: "ntly_...")
Nuntly.Namespaces.create_namespace(
client,
%{
"name" => "name"
}
)Delete Namespace
Soft-delete a namespace. Rejects if it has active inboxes.
Arguments
client— ANuntly.Clientreturned byNuntly.new/1.namespace_id— Required path parameter, string.opts— Optional keyword list passed to Req for this request.
Example
client = Nuntly.new(api_key: "ntly_...")
Nuntly.Namespaces.delete_namespace(client, "namespace-id")List Namespace Inboxes
List inboxes in a namespace.
Arguments
client— ANuntly.Clientreturned byNuntly.new/1.namespace_id— Required path parameter, string.params— Optional map of query parameters:"cursor"— Optional query parameter, string. Pagination cursor from a previous response"limit"— Optional query parameter, integer. Maximum number of items to return Defaults to30.
opts— Optional keyword list passed to Req for this request.
Example
client = Nuntly.new(api_key: "ntly_...")
Nuntly.Namespaces.list_namespace_inboxes(
client,
"namespace-id",
%{
"cursor" => "cursor",
"limit" => 30
}
)List Namespaces
List all namespaces.
Arguments
client— ANuntly.Clientreturned byNuntly.new/1.params— Optional map of query parameters:"cursor"— Optional query parameter, string. Pagination cursor from a previous response"limit"— Optional query parameter, integer. Maximum number of items to return Defaults to30.
opts— Optional keyword list passed to Req for this request.
Example
client = Nuntly.new(api_key: "ntly_...")
Nuntly.Namespaces.list_namespaces(
client,
%{
"cursor" => "cursor",
"limit" => 30
}
)Retrieve Namespace
Retrieve a namespace with inbox stats.
Arguments
client— ANuntly.Clientreturned byNuntly.new/1.namespace_id— Required path parameter, string.opts— Optional keyword list passed to Req for this request.
Example
client = Nuntly.new(api_key: "ntly_...")
Nuntly.Namespaces.retrieve_namespace(client, "namespace-id")Update Namespace
Update a namespace.
Arguments
client— ANuntly.Clientreturned byNuntly.new/1.namespace_id— Required path parameter, string.body— application/json request body usingUpdateNamespaceRequest. Accepted fields:"name"(string, optional) — The display name of the namespace."externalId"(string or nil, optional) — An optional external identifier for the namespace.
opts— Optional keyword list passed to Req for this request.
Example
client = Nuntly.new(api_key: "ntly_...")
Nuntly.Namespaces.update_namespace(
client,
"namespace-id",
%{
"name" => "name"
}
)