Create or update a provider connection

PUT

http://localhost:8080/api/v1/provider-connections/:slug

PUT

/api/v1/provider-connections/:slug

1 curl -X PUT http://localhost:8080/api/v1/provider-connections/string \
2      -H "X-Api-Key: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "status": "disconnected",
6   "apiKey": "string",
7   "apiSecret": "string",
8   "webhookUrl": "string",
9   "baseUrl": "string",
10   "config": "string"
11 }'

1 {
2   "code": 972,
3   "isSuccess": true,
4   "message": "string",
5   "connection": {
6     "id": 7878,
7     "providerSlug": "string",
8     "status": "error",
9     "apiKey": "string",
10     "apiSecret": "string",
11     "webhookUrl": "string",
12     "baseUrl": "string",
13     "config": "string",
14     "lastSyncAt": "1967-07-28T13:54:57.933Z",
15     "lastError": "string",
16     "createdAt": "1995-06-03T15:31:17.497Z",
17     "updatedAt": "2020-01-26T05:27:01.983Z"
18   }
19 }

Upserts the connection. Validates that the provider slug exists.

Authentication

X-Api-Keystring

API Key authentication via header

Path parameters

slugstringRequired

Provider slug

Request

This endpoint expects an object.

statusstringRequired

apiKeystringRequired

apiSecretstringRequired

webhookUrlstringRequired

baseUrlstringRequired

configstringRequired

Response

codeinteger

isSuccessboolean

messagestring

connectionobject

Errors

400

Bad Request Error