Skip to main content
PATCH
/
projects
/
{projectIdOrName}
/
connections
/
{connectionId}
curl --request PATCH \
  --url https://api.withampersand.com/v1/projects/{projectIdOrName}/connections/{connectionId} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "updateMask": [
    "apiKey"
  ],
  "connection": {
    "apiKey": "new-api-key-value"
  }
}
'
{
  "id": "c3a1f9d2-7b4e-4f8a-9e6d-2c5b8a3f1e7d",
  "projectId": "a1b2c3d4-e5f6-4789-a012-3456789abcde",
  "provider": "salesforce",
  "group": {
    "groupRef": "8f2e4a6b-1c3d-4e5f-9a7b-0d8e6f2c4a1b",
    "groupName": "my-group"
  },
  "consumer": {
    "consumerRef": "d4e5f6a7-b8c9-4d0e-a1f2-3b4c5d6e7f8a",
    "consumerName": "my-consumer"
  },
  "providerWorkspaceRef": "my-org.my.salesforce.com",
  "authScheme": "apiKey",
  "status": "working",
  "createTime": "2023-07-13T21:34:44.816354Z",
  "updateTime": "2024-01-15T10:22:33.000000Z"
}

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
projectIdOrName
string
required

The Ampersand project ID or project name.

​
connectionId
string
required

The ID of the connection to update. You can find this via the list connections endpoint.

Body

application/json

Specify which fields to update in updateMask and provide corresponding values in connection. Fields in connection not listed in updateMask are ignored.

​
updateMask
enum<string>[]
required

Fields to update. Each entry must have a corresponding value in connection. Credential fields (apiKey, basicAuth, oauth2ClientCredentials, oauth2PasswordCredentials) must match the connection's existing auth scheme.

Available options:
providerWorkspaceRef,
providerMetadata,
apiKey,
basicAuth,
oauth2ClientCredentials,
oauth2PasswordCredentials
Example:
["apiKey"]
​
connection
Connection Request Body · object
required

Response

Connection updated successfully.

​
id
string
required

The connection ID.

Example:

"connection-123"

​
projectId
string
required

The Ampersand project ID.

Example:

"project-456"

​
provider
string
required

The SaaS provider that this Connection is for.

Example:

"salesforce"

​
group
Group · object
required
​
consumer
Consumer · object
required
​
createTime
string<date-time>
required

The time the connection was created.

Example:

"2023-07-13T21:34:44.816Z"

​
authScheme
enum<string>
required

The authentication scheme used for this connection.

Available options:
none,
apiKey,
basic,
oauth2/authorizationCode,
oauth2/authorizationCodePKCE,
oauth2/clientCredentials,
oauth2/password
Example:

"oauth2/authorizationCode"

​
status
enum<string>
required

The status of the connection.

  • created: The connection has just been created or the access token was just refreshed.
  • working: The connection has successfully been used to make a request.
  • bad_credentials: The connection encountered credential-related issues when making a request, or when attempting to refresh the access token.
Available options:
created,
working,
bad_credentials
Example:

"working"

​
providerApp
Provider App · object
​
providerWorkspaceRef
string

If available, the identifier for the provider workspace (e.g. the Salesforce subdomain)

Example:

"provider-workspace-123"

​
providerConsumerRef
string

If available, the ID that Salesforce/Hubspot uses to identify this user (e.g. Salesforce has IDs in the form of https://login.salesforce.com/id/00D4x0000019CQTEA2/0054x000000orJ4AA)

Example:

"provider-consumer-123"

​
updateTime
string<date-time>

The time the connection was last updated.

Example:

"2023-07-13T21:34:44.816Z"

​
oauth2AuthorizationCode
OAuth2 AuthorizationCode Token · object
​
apiKey
string

The API key used while making the connection.

Example:

"api-key-123"

​
providerMetadata
Provider Metadata · object