# Create connector

**POST /api/connectors**

Create a connector with the given data.


## Servers
- Logto endpoint address.: https://[tenant_id].logto.app (Logto endpoint address.)


## Authentication methods
- OAuth2


## Parameters



### Body: application/json (object)

- **config** (object)
  The connector config object that will be passed to the connector. The config object should be compatible with the connector factory.
- **connectorId** (string)
  The connector factory ID for creating the connector.
- **metadata** (object)
  Custom connector metadata, will be used to overwrite the default connector factory metadata.
- **syncProfile** (boolean)
  Whether to sync user profile from the identity provider to Logto at each sign-in. If `false`, the user profile will only be synced when the user is created.
- **id** (string)
  The unique ID for the connector. If not provided, a random ID will be generated.


## Responses
### 200
The created connector.

#### Body: application/json (object)
- **id** (string)

- **syncProfile** (boolean)

- **config** (object)
  arbitrary
- **metadata** (object)

- **connectorId** (string)

- **target** (string)

- **name** (object)
  Validator function
- **description** (object)
  Validator function
- **logo** (string)

- **logoDark** (string | null)

- **readme** (string)

- **configTemplate** (string)

- **formItems** (array[object])

- **customData** (object)

- **fromEmail** (string)

- **platform** (string | null)

- **isStandard** (boolean)

- **type** (string)

- **isDemo** (boolean)

- **extraInfo** (object)

- **usage** (number)


### 400
Bad Request

### 401
Unauthorized

### 403
The tenant has reached the maximum number of connectors.

### 422
Invalid request body.


[Powered by Bump.sh](https://bump.sh)