---
title: "Create a Provider"
method: POST
path: "/v1/providers"
tags: ["Providers API"]
---

# Create a Provider

`POST /v1/providers`

Use this endpoint to register a new communication provider (email or SMS) for use in authentication and notification flows.

## Request body

- ProviderInput — Information required to create a new communication provider.
  - `name` string, required — A unique name to identify the provider.
  - `category` 'Email' | 'SMS', required — The provider category.
  - `type` 'SendGrid' | 'Twilio', required — The provider implementation type.
  - `subType` string — Provider sub-type, if applicable.
  - `method` string — Authentication or delivery method.
  - `clientId` string — Client ID or API key for authenticating with the provider.
  - `clientSecret` string — Client secret or API secret for authenticating with the provider.
  - `clientId2` string — Secondary client ID, if applicable.
  - `clientSecret2` string — Secondary client secret, if applicable.
  - `host` string — SMTP or API host address (Email providers).
  - `port` integer — SMTP port (Email providers).
  - `disableSsl` boolean — Set to true to disable SSL/TLS (not recommended for production).
  - `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.

## Response `201`

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

- ProviderResponse — Information about a communication provider.
  - `id` string — Unique identifier of the provider.
  - `name` string — Name of the provider.
  - `category` 'Email' | 'SMS' — Provider category.
  - `type` 'SendGrid' | 'Twilio' — Provider implementation type.
  - `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.

## Other responses

- `400`
- `409`
- `500`

---

[API](https://skmtc.net/lerian/apis/identity-plugin.md) · [All operations](https://skmtc.net/lerian/apis/identity-plugin/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lerian/identity-plugin/versions/25daba385532/schema)