Connections

Update Connection

Updates the specified Connection. You can modify the name, credentials, or other parameters. The request body follows the same structure as the Create Connection endpoint.

put/connections/{projectId}/{connectionId}

Request

  • Base URL: https://partner.peaka.studio/api/v1
  • URL: https://partner.peaka.studio/api/v1/connections/{projectId}/{connectionId}
  • Auth: HTTP bearer

Path parameters

projectIdstring required

ID of the project

connectionIdstring required

ID of the connection

Request body

namestring

Name of the connection given by the user

typestring

Type of the connection: the connectionType value /connections/config returns for it, e.g. stripe, airtable, ORACLE. connectionType is accepted as another name for this field.

credentialobject

Credential object for the connection.

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

connectionCallbackstring

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

Example request

{
  "type": "stripe"
}

Response

Connection updated successfully

idstring

Connection ID

namestring

Name of the connection

typestring

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

urlstring

Oauth callback url if the connection is Oauth based.

Changes

No recorded changes to this operation across all 1 revision of this API.