Skip to main content
PUT
/
connections
/
{projectId}
/
{connectionId}
curl --request PUT \ --url https://partner.peaka.studio/api/v1/connections/{projectId}/{connectionId} \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "name": "exampleHubspotConnection", "type": "hubspot", "credential": { "clientId": "15d6b8c5-48ea-4955-8ce5-d04bb9adad25", "clientSecret": "64d70b56-ae19-4fee-9fa2-3e9113bcb202", "refreshToken": "eu1-eae3-1af4-583d-91d4-f6414699feea" } } '
{
  "id": "<string>",
  "name": "<string>",
  "type": "<string>",
  "url": "<string>"
}

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 - */*

OK

​
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.