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"
      ]
    ]
  }
}'
{
  "id": "provider-app-123",
  "projectId": "project-456",
  "externalRef": "external-id-123",
  "provider": "salesforce",
  "clientId": "client-id-123",
  "scopes": [
    [
      "oauth",
      "offline",
      "crm.read"
    ]
  ],
  "createTime": "2023-11-07T05:31:56Z",
  "updateTime": "2023-11-07T05:31:56Z"
}

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

Response

200
application/json

The updated provider app

The response is of type object.