Update a connection.
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": [
"providerWorkspaceRef",
"providerMetadata"
],
"connection": {
"providerWorkspaceRef": "<string>",
"providerMetadata": {},
"groupName": "<string>",
"groupRef": "group-123",
"consumerName": "<string>",
"consumerRef": "<string>",
"provider": "<string>",
"apiKey": "<string>",
"customAuth": {
"apiKey": "abcd1234",
"password": "secret"
},
"oauth2AuthorizationCode": {
"scopes": [
"<string>"
]
}
}
}
'import requests
url = "https://api.withampersand.com/v1/projects/{projectIdOrName}/connections/{connectionId}"
payload = {
"updateMask": ["providerWorkspaceRef", "providerMetadata"],
"connection": {
"providerWorkspaceRef": "<string>",
"providerMetadata": {},
"groupName": "<string>",
"groupRef": "group-123",
"consumerName": "<string>",
"consumerRef": "<string>",
"provider": "<string>",
"apiKey": "<string>",
"customAuth": {
"apiKey": "abcd1234",
"password": "secret"
},
"oauth2AuthorizationCode": { "scopes": ["<string>"] }
}
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
updateMask: ['providerWorkspaceRef', 'providerMetadata'],
connection: {
providerWorkspaceRef: '<string>',
providerMetadata: {},
groupName: '<string>',
groupRef: 'group-123',
consumerName: '<string>',
consumerRef: '<string>',
provider: '<string>',
apiKey: '<string>',
customAuth: {apiKey: 'abcd1234', password: 'secret'},
oauth2AuthorizationCode: {scopes: ['<string>']}
}
})
};
fetch('https://api.withampersand.com/v1/projects/{projectIdOrName}/connections/{connectionId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.withampersand.com/v1/projects/{projectIdOrName}/connections/{connectionId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'updateMask' => [
'providerWorkspaceRef',
'providerMetadata'
],
'connection' => [
'providerWorkspaceRef' => '<string>',
'providerMetadata' => [
],
'groupName' => '<string>',
'groupRef' => 'group-123',
'consumerName' => '<string>',
'consumerRef' => '<string>',
'provider' => '<string>',
'apiKey' => '<string>',
'customAuth' => [
'apiKey' => 'abcd1234',
'password' => 'secret'
],
'oauth2AuthorizationCode' => [
'scopes' => [
'<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.withampersand.com/v1/projects/{projectIdOrName}/connections/{connectionId}"
payload := strings.NewReader("{\n \"updateMask\": [\n \"providerWorkspaceRef\",\n \"providerMetadata\"\n ],\n \"connection\": {\n \"providerWorkspaceRef\": \"<string>\",\n \"providerMetadata\": {},\n \"groupName\": \"<string>\",\n \"groupRef\": \"group-123\",\n \"consumerName\": \"<string>\",\n \"consumerRef\": \"<string>\",\n \"provider\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"customAuth\": {\n \"apiKey\": \"abcd1234\",\n \"password\": \"secret\"\n },\n \"oauth2AuthorizationCode\": {\n \"scopes\": [\n \"<string>\"\n ]\n }\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.withampersand.com/v1/projects/{projectIdOrName}/connections/{connectionId}")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"updateMask\": [\n \"providerWorkspaceRef\",\n \"providerMetadata\"\n ],\n \"connection\": {\n \"providerWorkspaceRef\": \"<string>\",\n \"providerMetadata\": {},\n \"groupName\": \"<string>\",\n \"groupRef\": \"group-123\",\n \"consumerName\": \"<string>\",\n \"consumerRef\": \"<string>\",\n \"provider\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"customAuth\": {\n \"apiKey\": \"abcd1234\",\n \"password\": \"secret\"\n },\n \"oauth2AuthorizationCode\": {\n \"scopes\": [\n \"<string>\"\n ]\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withampersand.com/v1/projects/{projectIdOrName}/connections/{connectionId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"updateMask\": [\n \"providerWorkspaceRef\",\n \"providerMetadata\"\n ],\n \"connection\": {\n \"providerWorkspaceRef\": \"<string>\",\n \"providerMetadata\": {},\n \"groupName\": \"<string>\",\n \"groupRef\": \"group-123\",\n \"consumerName\": \"<string>\",\n \"consumerRef\": \"<string>\",\n \"provider\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"customAuth\": {\n \"apiKey\": \"abcd1234\",\n \"password\": \"secret\"\n },\n \"oauth2AuthorizationCode\": {\n \"scopes\": [\n \"<string>\"\n ]\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "connection-123",
"projectId": "project-456",
"provider": "salesforce",
"group": {
"groupRef": "group-123",
"groupName": "Super Customer",
"projectId": "project-456",
"createTime": "2023-07-13T21:34:44.816354Z",
"updateTime": "2023-07-13T21:34:44.816354Z"
},
"consumer": {
"consumerRef": "consumer-123",
"consumerName": "Super Customer",
"projectId": "project-456",
"createTime": "2023-07-13T21:34:44.816354Z",
"updateTime": "2023-07-13T21:34:44.816354Z"
},
"createTime": "2023-07-13T21:34:44.816354Z",
"authScheme": "oauth2/authorizationCode",
"status": "working",
"providerApp": {
"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"
]
],
"updateTime": "2023-11-07T05:31:56Z"
},
"providerWorkspaceRef": "provider-workspace-123",
"providerConsumerRef": "provider-consumer-123",
"updateTime": "2023-07-13T21:34:44.816354Z",
"oauth2AuthorizationCode": {
"accessToken": {
"token": "<string>",
"issuedAt": "2024-04-22T18:55:28.456076Z",
"expiresAt": "2024-10-22T18:55:28.456076Z"
},
"refreshToken": {
"token": "<string>",
"issuedAt": "2024-04-22T18:55:28.456076Z",
"expiresAt": "2024-10-22T18:55:28.456076Z"
},
"scopes": [
"<string>"
]
},
"apiKey": "api-key-123",
"providerMetadata": {}
}{
"type": "about:blank",
"href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types",
"title": "Bad Request",
"status": 400,
"detail": "The input message is incorrect",
"instance": "123456-1234-1235-4567489798",
"issues": [
{
"type": "about:blank",
"detail": "exampleNumericProperty should be numeric",
"in": "path",
"name": "exampleNumericProperty",
"value": "abc"
},
{
"type": "about:blank",
"title": "Input isn't valid with respect to schema",
"detail": "examplePropertyWithPattern a2345678901 doesn't match pattern '^\\d{11}$'",
"in": "body",
"name": "items[0].examplePropertyWithPattern",
"value": "a2345678901"
}
]
}{
"type": "urn:problem-type:exampleOrganization:exampleProblem",
"href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types",
"title": "Description of the type of problem that occurred",
"status": 400,
"detail": "Description of specific occurrence of the problem",
"instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000"
}Connection
Update a connection.
Update an existing connection.
PATCH
/
projects
/
{projectIdOrName}
/
connections
/
{connectionId}
Update a connection.
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": [
"providerWorkspaceRef",
"providerMetadata"
],
"connection": {
"providerWorkspaceRef": "<string>",
"providerMetadata": {},
"groupName": "<string>",
"groupRef": "group-123",
"consumerName": "<string>",
"consumerRef": "<string>",
"provider": "<string>",
"apiKey": "<string>",
"customAuth": {
"apiKey": "abcd1234",
"password": "secret"
},
"oauth2AuthorizationCode": {
"scopes": [
"<string>"
]
}
}
}
'import requests
url = "https://api.withampersand.com/v1/projects/{projectIdOrName}/connections/{connectionId}"
payload = {
"updateMask": ["providerWorkspaceRef", "providerMetadata"],
"connection": {
"providerWorkspaceRef": "<string>",
"providerMetadata": {},
"groupName": "<string>",
"groupRef": "group-123",
"consumerName": "<string>",
"consumerRef": "<string>",
"provider": "<string>",
"apiKey": "<string>",
"customAuth": {
"apiKey": "abcd1234",
"password": "secret"
},
"oauth2AuthorizationCode": { "scopes": ["<string>"] }
}
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
updateMask: ['providerWorkspaceRef', 'providerMetadata'],
connection: {
providerWorkspaceRef: '<string>',
providerMetadata: {},
groupName: '<string>',
groupRef: 'group-123',
consumerName: '<string>',
consumerRef: '<string>',
provider: '<string>',
apiKey: '<string>',
customAuth: {apiKey: 'abcd1234', password: 'secret'},
oauth2AuthorizationCode: {scopes: ['<string>']}
}
})
};
fetch('https://api.withampersand.com/v1/projects/{projectIdOrName}/connections/{connectionId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.withampersand.com/v1/projects/{projectIdOrName}/connections/{connectionId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'updateMask' => [
'providerWorkspaceRef',
'providerMetadata'
],
'connection' => [
'providerWorkspaceRef' => '<string>',
'providerMetadata' => [
],
'groupName' => '<string>',
'groupRef' => 'group-123',
'consumerName' => '<string>',
'consumerRef' => '<string>',
'provider' => '<string>',
'apiKey' => '<string>',
'customAuth' => [
'apiKey' => 'abcd1234',
'password' => 'secret'
],
'oauth2AuthorizationCode' => [
'scopes' => [
'<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.withampersand.com/v1/projects/{projectIdOrName}/connections/{connectionId}"
payload := strings.NewReader("{\n \"updateMask\": [\n \"providerWorkspaceRef\",\n \"providerMetadata\"\n ],\n \"connection\": {\n \"providerWorkspaceRef\": \"<string>\",\n \"providerMetadata\": {},\n \"groupName\": \"<string>\",\n \"groupRef\": \"group-123\",\n \"consumerName\": \"<string>\",\n \"consumerRef\": \"<string>\",\n \"provider\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"customAuth\": {\n \"apiKey\": \"abcd1234\",\n \"password\": \"secret\"\n },\n \"oauth2AuthorizationCode\": {\n \"scopes\": [\n \"<string>\"\n ]\n }\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.withampersand.com/v1/projects/{projectIdOrName}/connections/{connectionId}")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"updateMask\": [\n \"providerWorkspaceRef\",\n \"providerMetadata\"\n ],\n \"connection\": {\n \"providerWorkspaceRef\": \"<string>\",\n \"providerMetadata\": {},\n \"groupName\": \"<string>\",\n \"groupRef\": \"group-123\",\n \"consumerName\": \"<string>\",\n \"consumerRef\": \"<string>\",\n \"provider\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"customAuth\": {\n \"apiKey\": \"abcd1234\",\n \"password\": \"secret\"\n },\n \"oauth2AuthorizationCode\": {\n \"scopes\": [\n \"<string>\"\n ]\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withampersand.com/v1/projects/{projectIdOrName}/connections/{connectionId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"updateMask\": [\n \"providerWorkspaceRef\",\n \"providerMetadata\"\n ],\n \"connection\": {\n \"providerWorkspaceRef\": \"<string>\",\n \"providerMetadata\": {},\n \"groupName\": \"<string>\",\n \"groupRef\": \"group-123\",\n \"consumerName\": \"<string>\",\n \"consumerRef\": \"<string>\",\n \"provider\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"customAuth\": {\n \"apiKey\": \"abcd1234\",\n \"password\": \"secret\"\n },\n \"oauth2AuthorizationCode\": {\n \"scopes\": [\n \"<string>\"\n ]\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "connection-123",
"projectId": "project-456",
"provider": "salesforce",
"group": {
"groupRef": "group-123",
"groupName": "Super Customer",
"projectId": "project-456",
"createTime": "2023-07-13T21:34:44.816354Z",
"updateTime": "2023-07-13T21:34:44.816354Z"
},
"consumer": {
"consumerRef": "consumer-123",
"consumerName": "Super Customer",
"projectId": "project-456",
"createTime": "2023-07-13T21:34:44.816354Z",
"updateTime": "2023-07-13T21:34:44.816354Z"
},
"createTime": "2023-07-13T21:34:44.816354Z",
"authScheme": "oauth2/authorizationCode",
"status": "working",
"providerApp": {
"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"
]
],
"updateTime": "2023-11-07T05:31:56Z"
},
"providerWorkspaceRef": "provider-workspace-123",
"providerConsumerRef": "provider-consumer-123",
"updateTime": "2023-07-13T21:34:44.816354Z",
"oauth2AuthorizationCode": {
"accessToken": {
"token": "<string>",
"issuedAt": "2024-04-22T18:55:28.456076Z",
"expiresAt": "2024-10-22T18:55:28.456076Z"
},
"refreshToken": {
"token": "<string>",
"issuedAt": "2024-04-22T18:55:28.456076Z",
"expiresAt": "2024-10-22T18:55:28.456076Z"
},
"scopes": [
"<string>"
]
},
"apiKey": "api-key-123",
"providerMetadata": {}
}{
"type": "about:blank",
"href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types",
"title": "Bad Request",
"status": 400,
"detail": "The input message is incorrect",
"instance": "123456-1234-1235-4567489798",
"issues": [
{
"type": "about:blank",
"detail": "exampleNumericProperty should be numeric",
"in": "path",
"name": "exampleNumericProperty",
"value": "abc"
},
{
"type": "about:blank",
"title": "Input isn't valid with respect to schema",
"detail": "examplePropertyWithPattern a2345678901 doesn't match pattern '^\\d{11}$'",
"in": "body",
"name": "items[0].examplePropertyWithPattern",
"value": "a2345678901"
}
]
}{
"type": "urn:problem-type:exampleOrganization:exampleProblem",
"href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types",
"title": "Description of the type of problem that occurred",
"status": 400,
"detail": "Description of specific occurrence of the problem",
"instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000"
}Authorizations
APIKeyHeaderBearer
Path Parameters
Project ID or Name.
Connection ID.
Body
application/json
Array of field paths specifying which fields to update. Allowed values include:
- providerWorkspaceRef
- providerMetadata
- apiKey
- basicAuth
- oauth2ClientCredentials
- oauth2PasswordCredentials
Example:
["providerWorkspaceRef", "providerMetadata"]
Show child attributes
Show child attributes
Response
Connection updated successfully.
The connection ID.
Example:
"connection-123"
The Ampersand project ID.
Example:
"project-456"
The SaaS provider that this Connection is for.
Example:
"salesforce"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The time the connection was created.
Example:
"2023-07-13T21:34:44.816354Z"
The authentication scheme used for this connection.
Available options:
none, apiKey, basic, oauth2/authorizationCode, oauth2/authorizationCodePKCE, oauth2/clientCredentials, oauth2/password Example:
"oauth2/authorizationCode"
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"
Show child attributes
Show child attributes
If available, the identifier for the provider workspace (e.g. the Salesforce subdomain)
Example:
"provider-workspace-123"
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"
The time the connection was last updated.
Example:
"2023-07-13T21:34:44.816354Z"
Show child attributes
Show child attributes
The API key used while making the connection.
Example:
"api-key-123"
Show child attributes
Show child attributes
Was this page helpful?
⌘I