Skip to content
/Template Scope

Message Templates (0.0.14)

Overview

The Message Template API provides the ability to create custom messaging (email, sms) templates that can be used to communicate with network users.

What This API Does

  • Create and manage message templates: Allows the creation and management of message templates within specific categories and template scopes that can be used for communication.
  • Register usages of templates: Registrations can be created to associated an external resource with a specific template using a custom ID.

Technical Details

  • Content Types: Supports application/json and application/vnd.ruckus.v1+json
  • API Version: v0.0.14
  • Data Formats: JSON with HATEOAS links for resource navigation
  • Pagination: Standard pagination with configurable page sizes

Example Use Case

A custom template can be created for use when a new user is assigned a unit in property management. This allows for custom branding or information to be provided to network users.

Authentication

All API calls require valid authentication via Bearer token in Authorization header. Include the JWT token in the Authorization: Bearer <token> header.

Error Handling

The API uses standard HTTP status codes with detailed error messages in the response body.

Common Error Responses

All endpoints may return these common error responses:

  • 400 Bad Request: Invalid input data or validation errors
  • 401 Unauthorized: Missing or invalid authentication
  • 403 Forbidden: Insufficient permissions
  • 404 Not Found: Requested resource doesn't exist
  • 409 Conflict: Resource conflict (e.g., duplicate names)
  • 422 Unprocessable Entity: Business rule violations
  • 500 Internal Server Error: Unexpected server errors
Download OpenAPI description
Download PDF
Overview
License
RUCKUS Cloud Privacy Policy
Languages
Servers
RUCKUS One API host for North American region.
https://api.ruckus.cloud
RUCKUS One API host for European region.
https://api.eu.ruckus.cloud
RUCKUS One API host for Asian region.
https://api.asia.ruckus.cloud

Variables

Retrieve variables available to templates within the given template scope.

Operations

Template Registrations

Retrieve template registrations.

Operations

Template Scope

Retrieve information about the template scope.

Operations

Retrieve All Template Scopes

Request

Returns all available template scopes.

Query
sizeany

Page size

pageany

The page to retrieve (starts at zero).

sortany

The field name to sort, comma separated from the sort order (asc or desc). Sortable fields are: id, messageType, and nameLocalizationKey

No request payload

Responses

The list of template scopes.

Body
pagingobject(Page Information)

The paging information for this response.

contentArray of objects(Template Scope)

The content list of the data.

_linksobject(Links)
Response
{
  "paging": {
    "totalCount": 0,
    "page": 0,
    "pageSize": 0,
    "pageCount": 0
  },
  "content": [
    { … }
  ],
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Get Template Scope

Request

Retrieves the template scope for the given id.

Path
templateScopeIdstring(uuid)required

Template scope id

Query
includesArray of strings

A comma separated list of child resources to include in the response in the format: includes={resource path},{resource path}. Where {resource path} must match the REST API path for that resource underneath the Template Scope. Only individual registrations are allowed. Any resource that is invalid or not found will be silently ignored. For example: includes=registrations/registration.id.1,registrations/registration.id.2

No request payload

Responses

Template scope

Body
idstring(uuid)
messageTypestring

The type of message, either EMAIL or SMS.

Enum"EMAIL""SMS"
nameLocalizationKeystring

A key which can be used by a user interface to locate a localized description of the template scope.

defaultTemplateIdstring(uuid)

The default template to use for this template scope. This will be used when sending a message if there is no requested template, or the requested template cannot be found.

registrationsArray of objects(Registration)

The list of registrations associated with this template scope.

_linksobject(Links)
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "messageType": "EMAIL",
  "nameLocalizationKey": "string",
  "defaultTemplateId": "bee715a2-1763-4940-8b0e-39be16b372e7",
  "registrations": [
    { … }
  ],
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Registrations

Manage template registrations.

Operations

Manage Templates

Manage Templates.

Operations