Generate OAuth authorization URL for existing connection

Generate a URL for the browser to render to kick off an OAuth flow that updates an existing connection. Use this when the connection’s credentials need to be refreshed. To start an OAuth flow without specifying a connection ID, use the /oauth-connect endpoint instead.

PATCH /projects/{projectIdOrName}/connections/{connectionId}:oauth-update

Generate OAuth authorization URL for existing connection

cURL

curl --request PATCH \
  --url https://api.withampersand.com/v1/projects/{projectIdOrName}/connections/{connectionId}:oauth-update \
  --header 'X-Api-Key: <api-key>'

200

"https://login.salesforce.com/services/oauth2/authorize?client_id=xxx&redirect_uri=https%3A%2F%2Fapi.withampersand.com%2Fcallbacks%2Fv1%2Foauth&state=xxx"

Authorizations

APIKeyHeaderBearer

X-Api-Key · string · header · required

Path Parameters

projectIdOrName · string · required

Ampersand project ID or name.

connectionId · string · required

The ID of the connection to update.

Response

200

text/plain

URL to initiate OAuth flow

The response is of type string.

Example:

"https://login.salesforce.com/services/oauth2/authorize?client_id=xxx&redirect_uri=https%3A%2F%2Fapi.withampersand.com%2Fcallbacks%2Fv1%2Foauth&state=xxx"