Skip to main content
POST
/
v1
/
providers
Create a Provider
curl --request POST \
  --url https://identity.sandbox.lerian.net/v1/providers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "sendgrid-primary",
  "category": "Email",
  "type": "SendGrid",
  "clientId": "SG.your_api_key_here",
  "clientSecret": "your_secret",
  "host": "smtp.sendgrid.net",
  "port": 587,
  "disableSsl": false
}
'
{ "id": "019c96a0-1a10-7abc-d1e2-8c9d0e1f2a3b", "name": "sendgrid-primary", "category": "Email", "type": "SendGrid", "host": "smtp.sendgrid.net", "port": 587, "disableSsl": false, "createdAt": "2025-04-08T08:01:30.000Z" }

Documentation Index

Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

The authorization token in the 'Bearer ' format.

Body

application/json

Information required to create a new communication provider.

​
name
string
required

A unique name to identify the provider.

​
category
enum<string>
required

The provider category.

Available options:
Email,
SMS
​
type
enum<string>
required

The provider implementation type.

Available options:
SendGrid,
Twilio
​
clientId
string

Client ID or API key for authenticating with the provider.

​
clientSecret
string

Client secret or API secret for authenticating with the provider.

​
host
string

SMTP or API host address (Email providers).

​
port
integer

SMTP port (Email providers).

​
disableSsl
boolean
default:false

Set to true to disable SSL/TLS (not recommended for production).

Response

Indicates that the provider was successfully created and the operation was completed as expected.

Information about a communication provider.

​
id
string

Unique identifier of the provider.

​
name
string

Name of the provider.

​
category
enum<string>

Provider category.

Available options:
Email,
SMS
​
type
enum<string>

Provider implementation type.

Available options:
SendGrid,
Twilio
​
subType
string

Provider sub-type, if applicable.

​
method
string

Authentication or delivery method.

​
clientId
string

Client ID or API key (secret is never returned).

​
clientId2
string

Secondary client ID, if applicable.

​
host
string

SMTP or API host address.

​
port
integer

SMTP port.

​
disableSsl
boolean

Indicates whether SSL/TLS is disabled.

​
title
string

Default email or SMS title/subject.

​
content
string

Default message content template.

​
receiver
string

Default receiver address for testing.

​
regionId
string

Cloud region ID (provider-specific).

​
signName
string

SMS signature name (provider-specific).

​
templateCode
string

SMS template code (provider-specific).

​
appId
string

Application ID (provider-specific).

​
endpoint
string

Provider API endpoint URL.

​
intranetEndpoint
string

Intranet endpoint for private network access.

​
domain
string

Provider domain.

​
providerUrl
string

Provider-specific URL.

​
createdAt
string<date-time>

Timestamp marking when the provider was created.