Skip to main content
PUT

Authorizations

​
Authorization
string
header
required

Use the Authorization header with the value 'Bearer ' to authenticate. Partner API Keys have full access; Project API Keys are limited to their project scope. Learn more: https://docs.peaka.com/api-reference/authentication

Path Parameters

​
projectId
string
required

ID of the project

​
connectionId
string
required

ID of the connection

Body

application/json

Connection Request

​
name
string

Name of the connection given by the user

​
type
string

Type of connection.

Example: airtable for AirTable, stripe for Stripe, hubspot_access_token for HubSpot (with Access Token), etc.

Exact list can be fetched by following url: /connections/config

​
credential
object

Credential object for the connection.

Its structure is dependent on the connection type and can be fetched by following url: /connections/config

​
connectionCallback
string

The url to redirect to after an oauth connection is established.

Response

200 - application/json

Connection updated successfully

​
id
string

Connection ID

​
name
string

Name of the connection

​
type
string

Type of connection.

Example: airtable for AirTable, stripe for Stripe, hubspot_access_token for HubSpot (with Access Token), etc.

Exact list can be fetched by following url: /connections/config

​
url
string

Oauth callback url if the connection is Oauth based.