OTP Templates API

This API allows managing OTP (One-Time Password) templates in the system. It provides endpoints to create, read, update, and delete OTP templates, as well as to query and filter existing templates.

The OTP Template Object

The OTP Template object represents a template for sending OTP codes through different channels.

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "channel": "email",
  "label": "Email verification template",
  "lang": "es",
  "sender": "otps@altscore.ai",
  "subject": "Verification code",
  "slug": "tenant:123e4567-e89b-12d3-a456-426614174000",
  "title": "Your verification code",
  "headerLogo": "https://example.com/logo.png",
  "headerLogoHeight": "40px",
  "preOtpBlurb": "Use the following code to verify your account:",
  "posOtpBlurb": "This code will expire in 10 minutes.",
  "didNotAskMessage": "If you did not request this code, ignore this message.",
  "footerBlurb": "Thank you for using our service.",
  "footerLink": "https://example.com",
  "footerLinkLabel": "Visit our website",
  "footerSlogan": "Security first",
  "footerLogo": "https://example.com/footer-logo.png",
  "footerLogoHeight": "30px",
  "createdAt": "2023-01-01T00:00:00Z",
  "updatedAt": "2023-01-02T12:30:00Z"
}

Attributes

Attribute	Description	Type
id	Unique identifier of the template	String
channel	Sending channel (email, sms, or whatsapp)	String
label	Descriptive label of the template	String
lang	Language of the template	String
sender	Sender's email address (email only)	String
subject	Email subject (email only)	String
slug	Friendly identifier of the template	String
title	Message title	String
headerLogo	Header logo URL	String
headerLogoHeight	Header logo height	String
preOtpBlurb	Text before the OTP code	String
posOtpBlurb	Text after the OTP code	String
didNotAskMessage	Message for users who did not request the code	String
footerBlurb	Footer text	String
footerLink	Footer link URL	String
footerLinkLabel	Footer link label	String
footerSlogan	Footer slogan	String
footerLogo	Footer logo URL	String
footerLogoHeight	Footer logo height	String
createdAt	Template creation date	String (ISO 8601)
updatedAt	Last update date of the template	String (ISO 8601)

Available Operations

Create a New OTP Template

Creates a new OTP template in the system.

POST /v1/otp-templates

Input Parameters

Parameter	Description	Type	Required
label	Descriptive label of the template	String	Yes
channel	Sending channel (email or sms)	String	Yes
lang	Language of the template	String	No
subject	Email subject (email only)	String	No
slug	Friendly identifier of the template	String	No
title	Message title	String	No
headerLogo	Header logo URL	String	No
headerLogoHeight	Header logo height	String	No
preOtpBlurb	Text before the OTP code	String	No
posOtpBlurb	Text after the OTP code	String	No
didNotAskMessage	Message for users who did not request the code	String	No
footerBlurb	Footer text	String	No
footerLink	Footer link URL	String	No
footerLinkLabel	Footer link label	String	No
footerSlogan	Footer slogan	String	No
footerLogo	Footer logo URL	String	No
footerLogoHeight	Footer logo height	String	No

Request Example

{
  "label": "Email verification template",
  "channel": "email",
  "lang": "es",
  "subject": "Verification code",
  "title": "Your verification code",
  "preOtpBlurb": "Use the following code to verify your account:",
  "posOtpBlurb": "This code will expire in 10 minutes."
}

Successful Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

Update an OTP Template

Updates an existing OTP template.

PATCH /v1/otp-templates/:template_id

Path Parameters

Parameter	Description
template_id	ID of the template to update

Input Parameters

All parameters are optional and correspond to the fields of the OTP Template object that can be updated.

Request Example

{
  "subject": "New verification code",
  "preOtpBlurb": "Here is your new verification code:"
}

Successful Response

The response will be the updated OTP Template object.

Get an OTP Template

Retrieves information of a specific OTP template.

GET /v1/otp-templates/:template_id

Path Parameters

Parameter	Description
template_id	ID of the template to retrieve

Successful Response

The response will be the complete OTP Template object.

List OTP Templates

Retrieves a paginated list of OTP templates with filtering and sorting options.

GET /v1/otp-templates

Query Parameters

Parameter	Description	Type
channel	Filter by sending channel	String
search	Text to search in the templates	String
page	Page number	Integer
per-page	Items per page	Integer
sort-by	Field to sort by	String
sort-direction	Sorting direction (asc or desc)	String

Successful Response

The response will be a paginated list of OTP Template objects.

Delete an OTP Template

Deletes an OTP template from the system.

DELETE /v1/otp-templates/:template_id

Path Parameters

Parameter	Description
template_id	ID of the template to delete

Successful Response

Status code 204 (No Content) if the deletion was successful.

Error Handling

The API may return the following error codes:

Code	Description
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal Server Error

Errors will include a descriptive message in the response body.

On this page