Create a new connected account

POST

https://backend.composio.dev/api/v3/connected_accounts

POST

/api/v3/connected_accounts

1 curl -X POST https://backend.composio.dev/api/v3/connected_accounts \
2      -H "x-api-key: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "auth_config": {
6     "id": "id"
7   },
8   "connection": {}
9 }'

Try it

201Created

1 {
2   "id": "id",
3   "connectionData": {
4     "authScheme": "OAUTH1",
5     "val": {
6       "status": "INITIALIZING",
7       "COMPANYDOMAIN": "COMPANYDOMAIN",
8       "account_id": "account_id",
9       "account_url": "account_url",
10       "api_url": "api_url",
11       "base_url": "base_url",
12       "borneo_dashboard_url": "borneo_dashboard_url",
13       "dc": "dc",
14       "domain": "domain",
15       "extension": "extension",
16       "form_api_base_url": "form_api_base_url",
17       "instanceEndpoint": "instanceEndpoint",
18       "instanceName": "instanceName",
19       "proxy_password": "proxy_password",
20       "proxy_username": "proxy_username",
21       "region": "region",
22       "server_location": "server_location",
23       "shop": "shop",
24       "site_name": "site_name",
25       "subdomain": "subdomain",
26       "version": "version",
27       "your-domain": "your-domain",
28       "your_server": "your_server"
29     }
30   },
31   "deprecated": {
32     "uuid": "uuid",
33     "authConfigUuid": "authConfigUuid"
34   }
35 }

Headers

x-api-keystringRequired

Request

This endpoint expects an object.

auth_configobjectRequired

connectionobjectRequired

Response

Successfully created connected account

idstring

The id of the connected account

connectionDataobject

The connection data of the connected account

deprecatedobject

Headers

Request

Response

Errors