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.

Path prefixes:

• /notifications-srv/* — current template, notification, and service-setup APIs.
• /notification-srv/sentitems/update/webhook/{type}/{vendor} — provider delivery-status webhooks (implemented by the notification core service under the notification-srv context path).

Scopes (selected): cidaas:templates_read|write|delete, cidaas:communication_send, cidaas:communication_status_read|write, cidaas:email_status_update, cidaas:sms_status_update, cidaas:service_setups_read|write|delete.

Service error codes in the public error envelope code field that API consumers commonly need to handle include 35002 (invalid data), 35010 (not found), 35018 (template type not found), and 35017/35020 (template disabled or draft). Do not treat every numeric code in the service as a supported public contract without the matching documented operation response.

Authentication

OAuth 2.0: OAuth2

Security Scheme Type:	oauth2
OAuth Flow (authorizationCode):	Token URL: https://domain/token-srv/token Authorization URL: https://domain/authz-srv/authz Refresh URL: https://baseurl/token-srv/token Scopes: cidaas:templates_read: Read template groups, template types, and templates cidaas:templates_write: Create and update template groups, template types, and templates cidaas:templates_delete: Delete template groups and templates cidaas:email_status_update: Update email sent-item status via provider webhook cidaas:sms_status_update: Update SMS sent-item status via provider webhook cidaas:communication_send: Send notifications cidaas:communication_status_read: Read notification / sent-item status cidaas:communication_status_write: Update notification / sent-item status cidaas:service_setups_read: Read communication service setups cidaas:service_setups_write: Create and update communication service setups cidaas:service_setups_delete: Delete communication service setups cidaas:provider_config_write: Create provider configurations cidaas:email_send: Legacy email send (deprecated routes)
OAuth Flow (clientCredentials):	Token URL: https://domain/token-srv/token Scopes: cidaas:templates_read: Read template groups, template types, and templates cidaas:templates_write: Create and update template groups, template types, and templates cidaas:templates_delete: Delete template groups and templates cidaas:email_status_update: Update email sent-item status via provider webhook cidaas:sms_status_update: Update SMS sent-item status via provider webhook cidaas:communication_send: Send notifications cidaas:communication_status_read: Read notification / sent-item status cidaas:communication_status_write: Update notification / sent-item status cidaas:service_setups_read: Read communication service setups cidaas:service_setups_write: Create and update communication service setups cidaas:service_setups_delete: Delete communication service setups cidaas:provider_config_write: Create provider configurations cidaas:email_send: Legacy email send (deprecated routes)
OAuth Flow (implicit):	Authorization URL: https://domain/authz-srv/authz Scopes: cidaas:templates_read: Read template groups, template types, and templates cidaas:templates_write: Create and update template groups, template types, and templates cidaas:templates_delete: Delete template groups and templates cidaas:email_status_update: Update email sent-item status via provider webhook cidaas:sms_status_update: Update SMS sent-item status via provider webhook cidaas:communication_send: Send notifications cidaas:communication_status_read: Read notification / sent-item status cidaas:communication_status_write: Update notification / sent-item status cidaas:service_setups_read: Read communication service setups cidaas:service_setups_write: Create and update communication service setups cidaas:service_setups_delete: Delete communication service setups cidaas:provider_config_write: Create provider configurations cidaas:email_send: Legacy email send (deprecated routes)

Contact

cidaas support: [email protected]

URL: https://support.cidaas.com

Terms of Service

https://www.cidaas.com/terms-of-use/