v1
latestOpenAPI 3.1.02026-07-263644911022.4 KBCreate a Provider
Use this endpoint to register a new communication provider (email or SMS) for use in authentication and notification flows.
Request body
A unique name to identify the provider.
The provider category.
The provider implementation type.
Provider sub-type, if applicable.
Authentication or delivery method.
Client ID or API key for authenticating with the provider.
Client secret or API secret for authenticating with the provider.
Secondary client ID, if applicable.
Secondary client secret, if applicable.
SMTP or API host address (Email providers).
SMTP port (Email providers).
Set to true to disable SSL/TLS (not recommended for production).
Default email or SMS title/subject.
Default message content template.
Default receiver address for testing.
Cloud region ID (provider-specific).
SMS signature name (provider-specific).
SMS template code (provider-specific).
Application ID (provider-specific).
Provider API endpoint URL.
Intranet endpoint for private network access.
Provider domain.
Response
Indicates that the provider was successfully created and the operation was completed as expected.
Unique identifier of the provider.
Name of the provider.
Provider category.
Provider implementation type.
Provider sub-type, if applicable.
Authentication or delivery method.
Client ID or API key (secret is never returned).
Secondary client ID, if applicable.
SMTP or API host address.
SMTP port.
Indicates whether SSL/TLS is disabled.
Default email or SMS title/subject.
Default message content template.
Default receiver address for testing.
Cloud region ID (provider-specific).
SMS signature name (provider-specific).
SMS template code (provider-specific).
Application ID (provider-specific).
Provider API endpoint URL.
Intranet endpoint for private network access.
Provider domain.
Provider-specific URL.
Timestamp marking when the provider was created.