Create or replace an OAuth connection

Stores encrypted provider credentials for a workspace. For Lead Perfection, this accepts username/password/clientid/appkey and optionally apiBaseUrl.

POST

https://api.channelautomation.com/api/oauth/connections

Authorization

BearerAuth
optional
HTTP Bearer (JWT)

ApiKeyAuth
optional
API key in header

Header parameters

x-workspace-id
string
required

Request body JSON required

provider
string
required
displayName
optional
string
environment
optional
production
or
sandbox
or
integration
credentials
optional
object
- username
  optional
  string
- password
  optional
  string
  format: password
- clientid
  optional
  string
- appkey
  optional
  string
  format: password
- apiBaseUrl
  optional
  string
}

Returns

201

Connection saved without returning sensitive fields.

400

Missing required fields.

500

Internal server error

JSON

error
optional
string
details
optional
string
success
optional
boolean

Create or replace an OAuth connection

curl --request POST \
  --url https://api.channelautomation.com/api/oauth/connections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-workspace-id: string' \
  --data '
{
  "provider": "leadperfection",
  "displayName": "string",
  "environment": "production",
  "credentials": {
    "username": "string",
    "password": "pa$$word",
    "clientid": "string",
    "appkey": "pa$$word",
    "apiBaseUrl": "https://api2.leadperfection.com"
  }
}
'

const url = 'https://api.channelautomation.com/api/oauth/connections';
const options = {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'x-workspace-id': 'string',
    Authorization: 'Bearer <token>'
  },
  body: JSON.stringify({
    provider: 'leadperfection',
    displayName: 'string',
    environment: 'production',
    credentials: {
      username: 'string',
      password: 'pa$$word',
      clientid: 'string',
      appkey: 'pa$$word',
      apiBaseUrl: 'https://api2.leadperfection.com'
    }
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.channelautomation.com/api/oauth/connections"

payload = {
    "provider": "leadperfection",
    "displayName": "string",
    "environment": "production",
    "credentials": {
        "username": "string",
        "password": "pa$$word",
        "clientid": "string",
        "appkey": "pa$$word",
        "apiBaseUrl": "https://api2.leadperfection.com"
    }
}
headers = {
    "Content-Type": "application/json",
    "x-workspace-id": "string",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Response example

{
  "error": "Internal server error",
  "details": "string",
  "success": false
}