Update a Provider

Use this endpoint to update a provider’s configuration. Note that category and type cannot be changed after creation.

PATCH /v1/providers/{id}

Update a Provider

cURL

curl --request PATCH \
  --url https://identity.sandbox.lerian.net/v1/providers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "sendgrid-primary-v2",
  "host": "smtp.sendgrid.net",
  "port": 465,
  "disableSsl": true
}
'

200

Example

{
  "id": "019c96a0-1a10-7abc-d1e2-8c9d0e1f2a3b",
  "name": "sendgrid-primary-v2",
  "category": "Email",
  "type": "SendGrid",
  "host": "smtp.sendgrid.net",
  "port": 465,
  "disableSsl": true,
  "createdAt": "2025-04-08T08:01:30.000Z"
}

Authorizations

Authorization · string · header · required

The authorization token in the 'Bearer ' format.

Path Parameters

id · string · required

The unique identifier of the provider.

Body

application/json

Information used to update an existing provider. Note that category and type are immutable after creation.

name · string

Updated name for the provider.

subType · string

Updated provider sub-type.

method · string

Updated authentication or delivery method.

clientId · string

Updated client ID or API key.

clientSecret · string

Updated client secret or API secret.

clientId2 · string

Updated secondary client ID.

clientSecret2 · string

Updated secondary client secret.

host · string

Updated SMTP or API host address.

port · integer

Updated SMTP port.

disableSsl · boolean

Updated SSL/TLS setting.

title · string

Updated default email or SMS title/subject.

content · string

Updated default message content template.

receiver · string

Updated default receiver address for testing.

regionId · string

Updated cloud region ID.

signName · string

Updated SMS signature name.

templateCode · string

Updated SMS template code.

appId · string

Updated application ID.

endpoint · string

Updated provider API endpoint URL.

intranetEndpoint · string

Updated intranet endpoint for private network access.

domain · string

Updated provider domain.

Response

200

application/json

Indicates that the provider was successfully updated 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.