Sign in

v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Providers API

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}

Path parameters

idstring required

The unique identifier of the provider.

Request body

namestring

Updated name for the provider.

subTypestring

Updated provider sub-type.

methodstring

Updated authentication or delivery method.

clientIdstring

Updated client ID or API key.

clientSecretstring

Updated client secret or API secret.

clientId2string

Updated secondary client ID.

clientSecret2string

Updated secondary client secret.

hoststring

Updated SMTP or API host address.

portinteger

Updated SMTP port.

disableSslboolean

Updated SSL/TLS setting.

titlestring

Updated default email or SMS title/subject.

contentstring

Updated default message content template.

receiverstring

Updated default receiver address for testing.

regionIdstring

Updated cloud region ID.

signNamestring

Updated SMS signature name.

templateCodestring

Updated SMS template code.

appIdstring

Updated application ID.

endpointstring

Updated provider API endpoint URL.

intranetEndpointstring

Updated intranet endpoint for private network access.

domainstring

Updated provider domain.

Response

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

idstring

Unique identifier of the provider.

namestring

Name of the provider.

category'Email' | 'SMS'

Provider category.

type'SendGrid' | 'Twilio'

Provider implementation type.

subTypestring

Provider sub-type, if applicable.

methodstring

Authentication or delivery method.

clientIdstring

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

clientId2string

Secondary client ID, if applicable.

hoststring

SMTP or API host address.

portinteger

SMTP port.

disableSslboolean

Indicates whether SSL/TLS is disabled.

titlestring

Default email or SMS title/subject.

contentstring

Default message content template.

receiverstring

Default receiver address for testing.

regionIdstring

Cloud region ID (provider-specific).

signNamestring

SMS signature name (provider-specific).

templateCodestring

SMS template code (provider-specific).

appIdstring

Application ID (provider-specific).

endpointstring

Provider API endpoint URL.

intranetEndpointstring

Intranet endpoint for private network access.

domainstring

Provider domain.

providerUrlstring

Provider-specific URL.

createdAtstring date-time

Timestamp marking when the provider was created.