Skip to main content
PATCH
/
projects
/
{projectIdOrName}
/
provider-apps
/
{providerAppId}
Update a provider app
curl --request PATCH \
  --url https://api.withampersand.com/v1/projects/{projectIdOrName}/provider-apps/{providerAppId} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "updateMask": [
    "externalRef",
    "clientId"
  ],
  "providerApp": {
    "externalRef": "external-id-123",
    "provider": "salesforce",
    "clientId": "client-id-123",
    "clientSecret": "client-secret-123",
    "scopes": [
      [
        "read",
        "write"
      ]
    ],
    "metadata": {
      "authQueryParams": {
        "optional_scope": [
          "automation.sequences.read"
        ]
      },
      "providerParams": {
        "packageInstallURL": "https://login.salesforce.com/packaging/installPackage.apexp?p0=04t123456789",
        "gcpProjectId": "my-gcp-project",
        "gcpPubSubTopicName": "my-topic"
      }
    }
  }
}
'
{
  "id": "provider-app-123",
  "projectId": "project-456",
  "provider": "salesforce",
  "clientId": "client-id-123",
  "createTime": "2023-11-07T05:31:56Z",
  "externalRef": "external-id-123",
  "scopes": [
    [
      "oauth",
      "offline",
      "crm.read"
    ]
  ],
  "metadata": {
    "authQueryParams": {
      "optional_scope": [
        "automation.sequences.read"
      ]
    },
    "providerParams": {
      "packageInstallURL": "https://login.salesforce.com/packaging/installPackage.apexp?p0=04t123456789",
      "gcpProjectId": "my-gcp-project",
      "gcpPubSubTopicName": "my-topic"
    }
  },
  "updateTime": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.withampersand.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
projectIdOrName
string
required

The Ampersand project ID or project name.

​
providerAppId
string
required

ID of the provider app, returned by the CreateProviderApp call.

Body

application/json
​
updateMask
string[]
required

Array of field paths specifying which fields to update. Allowed values include:

  • externalRef
  • clientId
  • clientSecret
  • provider
  • scopes
  • metadata
Example:
["externalRef", "clientId"]
​
providerApp
object
required

The provider app fields to update. (Only include the fields you'd like to update.)

Response

The updated provider app

​
id
string
required

The provider app ID.

Example:

"provider-app-123"

​
projectId
string
required

The Ampersand project ID.

Example:

"project-456"

​
provider
string
required

The SaaS provider that this app connects to.

Example:

"salesforce"

​
clientId
string
required

The OAuth client ID for this app.

Example:

"client-id-123"

​
createTime
string<date-time>
required

The time the provider app was created.

​
externalRef
string

The ID used by the provider to identify the app (optional).

Example:

"external-id-123"

​
scopes
string[]

The OAuth scopes for this app.

​
metadata
Provider App Metadata · object

Provider-specific configuration that extends the standard OAuth flow.

​
updateTime
string<date-time>

The time the provider app was updated.