Update marketplace integration
curl --request PUT \
--url https://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/integration/{integrationId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Tenant-Id: <tenant-id>' \
--data '
{
"name": "<string>",
"description": "<string>",
"overview": "<string>",
"instructions": "<string>",
"website_url": "<string>",
"company": "<string>",
"id": "<string>",
"sk": "<string>",
"type": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"is_free": true,
"doc": "<string>",
"support_url": "<string>",
"privacy_policy_url": "<string>",
"icon": "<string>",
"is_active": true,
"env_variables": [
{
"name": "<string>",
"value": "<string>",
"id": "<string>",
"sensitive": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"actor": "<string>"
}
]
}
'import requests
url = "https://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/integration/{integrationId}"
payload = {
"name": "<string>",
"description": "<string>",
"overview": "<string>",
"instructions": "<string>",
"website_url": "<string>",
"company": "<string>",
"id": "<string>",
"sk": "<string>",
"type": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"is_free": True,
"doc": "<string>",
"support_url": "<string>",
"privacy_policy_url": "<string>",
"icon": "<string>",
"is_active": True,
"env_variables": [
{
"name": "<string>",
"value": "<string>",
"id": "<string>",
"sensitive": True,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"actor": "<string>"
}
]
}
headers = {
"Tenant-Id": "<tenant-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'Tenant-Id': '<tenant-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
description: '<string>',
overview: '<string>',
instructions: '<string>',
website_url: '<string>',
company: '<string>',
id: '<string>',
sk: '<string>',
type: '<string>',
created_at: '2023-11-07T05:31:56Z',
is_free: true,
doc: '<string>',
support_url: '<string>',
privacy_policy_url: '<string>',
icon: '<string>',
is_active: true,
env_variables: [
{
name: '<string>',
value: '<string>',
id: '<string>',
sensitive: true,
created_at: '2023-11-07T05:31:56Z',
updated_at: '2023-11-07T05:31:56Z',
actor: '<string>'
}
]
})
};
fetch('https://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/integration/{integrationId}', 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://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/integration/{integrationId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'overview' => '<string>',
'instructions' => '<string>',
'website_url' => '<string>',
'company' => '<string>',
'id' => '<string>',
'sk' => '<string>',
'type' => '<string>',
'created_at' => '2023-11-07T05:31:56Z',
'is_free' => true,
'doc' => '<string>',
'support_url' => '<string>',
'privacy_policy_url' => '<string>',
'icon' => '<string>',
'is_active' => true,
'env_variables' => [
[
'name' => '<string>',
'value' => '<string>',
'id' => '<string>',
'sensitive' => true,
'created_at' => '2023-11-07T05:31:56Z',
'updated_at' => '2023-11-07T05:31:56Z',
'actor' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Tenant-Id: <tenant-id>"
],
]);
$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://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/integration/{integrationId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"overview\": \"<string>\",\n \"instructions\": \"<string>\",\n \"website_url\": \"<string>\",\n \"company\": \"<string>\",\n \"id\": \"<string>\",\n \"sk\": \"<string>\",\n \"type\": \"<string>\",\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"is_free\": true,\n \"doc\": \"<string>\",\n \"support_url\": \"<string>\",\n \"privacy_policy_url\": \"<string>\",\n \"icon\": \"<string>\",\n \"is_active\": true,\n \"env_variables\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"id\": \"<string>\",\n \"sensitive\": true,\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"updated_at\": \"2023-11-07T05:31:56Z\",\n \"actor\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Tenant-Id", "<tenant-id>")
req.Header.Add("Authorization", "Bearer <token>")
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.put("https://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/integration/{integrationId}")
.header("Tenant-Id", "<tenant-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"overview\": \"<string>\",\n \"instructions\": \"<string>\",\n \"website_url\": \"<string>\",\n \"company\": \"<string>\",\n \"id\": \"<string>\",\n \"sk\": \"<string>\",\n \"type\": \"<string>\",\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"is_free\": true,\n \"doc\": \"<string>\",\n \"support_url\": \"<string>\",\n \"privacy_policy_url\": \"<string>\",\n \"icon\": \"<string>\",\n \"is_active\": true,\n \"env_variables\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"id\": \"<string>\",\n \"sensitive\": true,\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"updated_at\": \"2023-11-07T05:31:56Z\",\n \"actor\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/integration/{integrationId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Tenant-Id"] = '<tenant-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"overview\": \"<string>\",\n \"instructions\": \"<string>\",\n \"website_url\": \"<string>\",\n \"company\": \"<string>\",\n \"id\": \"<string>\",\n \"sk\": \"<string>\",\n \"type\": \"<string>\",\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"is_free\": true,\n \"doc\": \"<string>\",\n \"support_url\": \"<string>\",\n \"privacy_policy_url\": \"<string>\",\n \"icon\": \"<string>\",\n \"is_active\": true,\n \"env_variables\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"id\": \"<string>\",\n \"sensitive\": true,\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"updated_at\": \"2023-11-07T05:31:56Z\",\n \"actor\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"description": "<string>",
"overview": "<string>",
"instructions": "<string>",
"category": "PAYMENT",
"website_url": "<string>",
"company": "<string>",
"id": "<string>",
"sk": "<string>",
"type": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"is_free": true,
"doc": "<string>",
"support_url": "<string>",
"privacy_policy_url": "<string>",
"icon": "<string>",
"is_active": true,
"env_variables": [
{
"name": "<string>",
"value": "<string>",
"id": "<string>",
"sensitive": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"actor": "<string>"
}
]
}{
"code": "common.internal_error",
"error": "<string>",
"meta": {}
}{
"code": "common.internal_error",
"error": "<string>",
"meta": {}
}{
"code": "common.internal_error",
"error": "<string>",
"meta": {}
}{
"code": "common.internal_error",
"error": "<string>",
"meta": {}
}{
"code": "common.internal_error",
"error": "<string>",
"meta": {}
}Integrations
Update marketplace integration
PUT
/
integration
/
{integrationId}
Update marketplace integration
curl --request PUT \
--url https://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/integration/{integrationId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Tenant-Id: <tenant-id>' \
--data '
{
"name": "<string>",
"description": "<string>",
"overview": "<string>",
"instructions": "<string>",
"website_url": "<string>",
"company": "<string>",
"id": "<string>",
"sk": "<string>",
"type": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"is_free": true,
"doc": "<string>",
"support_url": "<string>",
"privacy_policy_url": "<string>",
"icon": "<string>",
"is_active": true,
"env_variables": [
{
"name": "<string>",
"value": "<string>",
"id": "<string>",
"sensitive": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"actor": "<string>"
}
]
}
'import requests
url = "https://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/integration/{integrationId}"
payload = {
"name": "<string>",
"description": "<string>",
"overview": "<string>",
"instructions": "<string>",
"website_url": "<string>",
"company": "<string>",
"id": "<string>",
"sk": "<string>",
"type": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"is_free": True,
"doc": "<string>",
"support_url": "<string>",
"privacy_policy_url": "<string>",
"icon": "<string>",
"is_active": True,
"env_variables": [
{
"name": "<string>",
"value": "<string>",
"id": "<string>",
"sensitive": True,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"actor": "<string>"
}
]
}
headers = {
"Tenant-Id": "<tenant-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'Tenant-Id': '<tenant-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
description: '<string>',
overview: '<string>',
instructions: '<string>',
website_url: '<string>',
company: '<string>',
id: '<string>',
sk: '<string>',
type: '<string>',
created_at: '2023-11-07T05:31:56Z',
is_free: true,
doc: '<string>',
support_url: '<string>',
privacy_policy_url: '<string>',
icon: '<string>',
is_active: true,
env_variables: [
{
name: '<string>',
value: '<string>',
id: '<string>',
sensitive: true,
created_at: '2023-11-07T05:31:56Z',
updated_at: '2023-11-07T05:31:56Z',
actor: '<string>'
}
]
})
};
fetch('https://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/integration/{integrationId}', 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://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/integration/{integrationId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'overview' => '<string>',
'instructions' => '<string>',
'website_url' => '<string>',
'company' => '<string>',
'id' => '<string>',
'sk' => '<string>',
'type' => '<string>',
'created_at' => '2023-11-07T05:31:56Z',
'is_free' => true,
'doc' => '<string>',
'support_url' => '<string>',
'privacy_policy_url' => '<string>',
'icon' => '<string>',
'is_active' => true,
'env_variables' => [
[
'name' => '<string>',
'value' => '<string>',
'id' => '<string>',
'sensitive' => true,
'created_at' => '2023-11-07T05:31:56Z',
'updated_at' => '2023-11-07T05:31:56Z',
'actor' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Tenant-Id: <tenant-id>"
],
]);
$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://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/integration/{integrationId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"overview\": \"<string>\",\n \"instructions\": \"<string>\",\n \"website_url\": \"<string>\",\n \"company\": \"<string>\",\n \"id\": \"<string>\",\n \"sk\": \"<string>\",\n \"type\": \"<string>\",\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"is_free\": true,\n \"doc\": \"<string>\",\n \"support_url\": \"<string>\",\n \"privacy_policy_url\": \"<string>\",\n \"icon\": \"<string>\",\n \"is_active\": true,\n \"env_variables\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"id\": \"<string>\",\n \"sensitive\": true,\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"updated_at\": \"2023-11-07T05:31:56Z\",\n \"actor\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Tenant-Id", "<tenant-id>")
req.Header.Add("Authorization", "Bearer <token>")
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.put("https://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/integration/{integrationId}")
.header("Tenant-Id", "<tenant-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"overview\": \"<string>\",\n \"instructions\": \"<string>\",\n \"website_url\": \"<string>\",\n \"company\": \"<string>\",\n \"id\": \"<string>\",\n \"sk\": \"<string>\",\n \"type\": \"<string>\",\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"is_free\": true,\n \"doc\": \"<string>\",\n \"support_url\": \"<string>\",\n \"privacy_policy_url\": \"<string>\",\n \"icon\": \"<string>\",\n \"is_active\": true,\n \"env_variables\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"id\": \"<string>\",\n \"sensitive\": true,\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"updated_at\": \"2023-11-07T05:31:56Z\",\n \"actor\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/integration/{integrationId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Tenant-Id"] = '<tenant-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"overview\": \"<string>\",\n \"instructions\": \"<string>\",\n \"website_url\": \"<string>\",\n \"company\": \"<string>\",\n \"id\": \"<string>\",\n \"sk\": \"<string>\",\n \"type\": \"<string>\",\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"is_free\": true,\n \"doc\": \"<string>\",\n \"support_url\": \"<string>\",\n \"privacy_policy_url\": \"<string>\",\n \"icon\": \"<string>\",\n \"is_active\": true,\n \"env_variables\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"id\": \"<string>\",\n \"sensitive\": true,\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"updated_at\": \"2023-11-07T05:31:56Z\",\n \"actor\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"description": "<string>",
"overview": "<string>",
"instructions": "<string>",
"category": "PAYMENT",
"website_url": "<string>",
"company": "<string>",
"id": "<string>",
"sk": "<string>",
"type": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"is_free": true,
"doc": "<string>",
"support_url": "<string>",
"privacy_policy_url": "<string>",
"icon": "<string>",
"is_active": true,
"env_variables": [
{
"name": "<string>",
"value": "<string>",
"id": "<string>",
"sensitive": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"actor": "<string>"
}
]
}{
"code": "common.internal_error",
"error": "<string>",
"meta": {}
}{
"code": "common.internal_error",
"error": "<string>",
"meta": {}
}{
"code": "common.internal_error",
"error": "<string>",
"meta": {}
}{
"code": "common.internal_error",
"error": "<string>",
"meta": {}
}{
"code": "common.internal_error",
"error": "<string>",
"meta": {}
}Authorizations
BearerAuthApiKeyAuth
Bearer token in the Authorization header (e.g. JWT / Cognito access token).
Headers
ID of the tenant (current tenant context).
Path Parameters
Integration identifier.
Body
application/json
Integration attached to a project (marketplace metadata + env vars).
Integration marketplace category.
Available options:
PAYMENT, CRM, MARKETING, ACCOUNTING, OTHER Show child attributes
Show child attributes
Response
OK
Integration attached to a project (marketplace metadata + env vars).
Integration marketplace category.
Available options:
PAYMENT, CRM, MARKETING, ACCOUNTING, OTHER Show child attributes
Show child attributes