Version: 2.0
notifications and communication templates API
cidaas templates and notifications API
This API provides comprehensive functionality for managing communication templates and notifications in cidaas.
Template Management:
Template APIs allow you to manage email, SMS, IVR, and other communication templates provided by cidaas. You can also create custom templates per your requirements. Templates send password reset emails or SMS, one-time passwords, or email/mobile verification messages. Beyond these typical use cases, templates handle scenarios like "accessed by new device" notifications or account deactivation and activation.
Notification Management:
This API also handles sending notifications through various communication channels and tracking notification statuses. You can send template-based notifications and update sent item statuses for email and SMS communication providers using REST API and SMTP webhooks.
Authentication
Security Scheme Type: | oauth2 |
|---|
OAuth Flow (authorizationCode): | Scopes: cidaas:cidaas_templates_read: Used to enable read access for the templates. cidaas:cidaas_templates_write: Used to enable write access for the templates. cidaas:cidaas_templates_delete: Used to enable delete access which allows to delete templates. cidaas:templates_read: read the template group, template type and templates cidaas:templates_write: write the template group, template type and templates cidaas:email_status_update: update email sent item status cidaas:sms_status_update: update SMS sent item status cidaas:communication_send: send the notification cidaas:notification_status_read: read notification status cidaas:communication_status_write: write notification status cidaas:email_send: cidaas email send
|
|---|
OAuth Flow (clientCredentials): | Scopes: cidaas:cidaas_templates_read: Used to enable read access for the templates. cidaas:cidaas_templates_write: Used to enable write access for the templates. cidaas:cidaas_templates_delete: Used to enable delete access which allows to delete templates. cidaas:templates_read: read the template group, template type and templates cidaas:templates_write: write the template group, template type and templates cidaas:email_status_update: update email sent item status cidaas:sms_status_update: update SMS sent item status cidaas:communication_send: send the notification cidaas:notification_status_read: read notification status cidaas:communication_status_write: write notification status cidaas:email_send: cidaas email send
|
|---|
OAuth Flow (implicit): | Scopes: cidaas:cidaas_templates_read: Used to enable read access for the templates. cidaas:cidaas_templates_write: Used to enable write access for the templates. cidaas:cidaas_templates_delete: Used to enable delete access which allows to delete templates. cidaas:templates_read: read the template group, template type and templates cidaas:templates_write: write the template group, template type and templates cidaas:email_status_update: update email sent item status cidaas:sms_status_update: update SMS sent item status cidaas:communication_send: send the notification cidaas:notification_status_read: read notification status cidaas:communication_status_write: write notification status cidaas:email_send: cidaas email send
|
|---|