Skip to content
Overview/
/Message Templates/
Changed
Last updated

Message Templates

GET /templateScopes
Parameters:
  • Changed: sort in query

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

Return Type:
  • Changed response : 200 OK

The list of template scopes.

  • New content type : application/vnd.ruckus.v1+json

  • Changed content type : application/json

    • Changed property paging (object)

      Describes of the page that was returned and the remaining items.

GET /templateScopes/{templateScopeId}
Parameters:
  • Changed: includes in query

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

Return Type:
  • Changed response : 404 Not Found

Template scope not found

  • New content type : application/vnd.ruckus.v1+json

  • Changed content type : application/json

    • Added property errors (object)

      Related standardized errors.

    • Changed property debugMessage (object)

      Additional information about the error.

    • Changed property message (object)

      A brief description of the error.

    • Changed property nestedErrors (object)

      Additional nested validation errors.

    • Changed property status (object)

      The HTTP status of the error response.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      The time the error occurred.

  • Changed response : 200 OK

Template scope

  • New content type : application/vnd.ruckus.v1+json

  • Changed content type : application/json

    • Changed property defaultTemplateId (object)

      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.

    • Changed property messageType (object)

      The type of message, either EMAIL or SMS.

    • Changed property nameLocalizationKey (object)

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

    • Changed property registrations (object)

      The list of registrations associated with this template scope.

GET /templateScopes/{templateScopeId}/registrations
Return Type:
  • Changed response : 404 Not Found

Template Scope not found

  • New content type : application/vnd.ruckus.v1+json

  • Changed content type : application/json

    • Added property errors (object)

      Related standardized errors.

    • Changed property debugMessage (object)

      Additional information about the error.

    • Changed property message (object)

      A brief description of the error.

    • Changed property nestedErrors (object)

      Additional nested validation errors.

    • Changed property status (object)

      The HTTP status of the error response.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      The time the error occurred.

  • Changed response : 200 OK

The list of registrations within the template scope.

  • New content type : application/vnd.ruckus.v1+json

  • Changed content type : application/json

    • Changed property paging (object)

      Describes of the page that was returned and the remaining items.

GET /templateScopes/{templateScopeId}/registrations/{registrationId}
Return Type:
  • Changed response : 404 Not Found

Template scope or registration not found.

  • New content type : application/vnd.ruckus.v1+json

  • Changed content type : application/json

    • Added property errors (object)

      Related standardized errors.

    • Changed property debugMessage (object)

      Additional information about the error.

    • Changed property message (object)

      A brief description of the error.

    • Changed property nestedErrors (object)

      Additional nested validation errors.

    • Changed property status (object)

      The HTTP status of the error response.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      The time the error occurred.

  • Changed response : 200 OK

The registration.

  • New content type : application/vnd.ruckus.v1+json

  • Changed content type : application/json

    New optional properties:

    • usageLocalizationKey
    • Changed property usageLocalizationKey (object)

      A key which can be used by a user interface to locate a localized description of where the referenced template is being used.

GET /templateScopes/{templateScopeId}/templates
Parameters:
  • Changed: sort in query

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

Return Type:
  • Changed response : 404 Not Found

Template Scope not found

  • New content type : application/vnd.ruckus.v1+json

  • Changed content type : application/json

    • Added property errors (object)

      Related standardized errors.

    • Changed property debugMessage (object)

      Additional information about the error.

    • Changed property message (object)

      A brief description of the error.

    • Changed property nestedErrors (object)

      Additional nested validation errors.

    • Changed property status (object)

      The HTTP status of the error response.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      The time the error occurred.

  • Changed response : 200 OK

The list of templates within the template scope.

  • New content type : application/vnd.ruckus.v1+json

  • Changed content type : application/json

    • Changed property paging (object)

      Describes of the page that was returned and the remaining items.

GET /templateScopes/{templateScopeId}/templates/{genericTemplateId}
Return Type:
  • Changed response : 404 Not Found

Template scope or template not found.

  • New content type : application/vnd.ruckus.v1+json

  • Changed content type : application/json

    • Added property errors (object)

      Related standardized errors.

    • Changed property debugMessage (object)

      Additional information about the error.

    • Changed property message (object)

      A brief description of the error.

    • Changed property nestedErrors (object)

      Additional nested validation errors.

    • Changed property status (object)

      The HTTP status of the error response.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      The time the error occurred.

  • Changed response : 200 OK

The template

  • New content type : application/vnd.ruckus.v1+json

  • Changed content type : application/json

    • Changed property extraFieldOneTemplate (object)

      An extra template field which can be used in conjunction with the template; used for the subject in email templates.

GET /templateScopes/{templateScopeId}/templates/{templateId}/registrations
Return Type:
  • Changed response : 404 Not Found

Template Scope not found

  • New content type : application/vnd.ruckus.v1+json

  • Changed content type : application/json

    • Added property errors (object)

      Related standardized errors.

    • Changed property debugMessage (object)

      Additional information about the error.

    • Changed property message (object)

      A brief description of the error.

    • Changed property nestedErrors (object)

      Additional nested validation errors.

    • Changed property status (object)

      The HTTP status of the error response.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      The time the error occurred.

  • Changed response : 200 OK

The list of registrations referencing the given template.

  • New content type : application/vnd.ruckus.v1+json

  • Changed content type : application/json

    • Changed property paging (object)

      Describes of the page that was returned and the remaining items.

GET /templateScopes/{templateScopeId}/variables
Return Type:
  • Changed response : 404 Not Found

Template scope not found.

  • New content type : application/vnd.ruckus.v1+json

  • Changed content type : application/json

    • Added property errors (object)

      Related standardized errors.

    • Changed property debugMessage (object)

      Additional information about the error.

    • Changed property message (object)

      A brief description of the error.

    • Changed property nestedErrors (object)

      Additional nested validation errors.

    • Changed property status (object)

      The HTTP status of the error response.

      Added enum value:

      • 103 EARLY_HINTS

    • Changed property timestamp (object)

      The time the error occurred.

  • Changed response : 200 OK

The list of variables available to templates within this template scope.

  • New content type : application/vnd.ruckus.v1+json

  • Changed content type : application/json

    • Changed property paging (object)

      Describes of the page that was returned and the remaining items.

Previous page
Next page