Skip to main content
POST
/
integrations
/
{name}
Edit client integration
curl --request POST \
  --url https://api.helpyousponsor.com/v1/integrations/{name} \
  --header 'Content-Type: application/json' \
  --header 'X-HYS-API-Key: <api-key>' \
  --data '
{
  "api": "<string>",
  "client_id": "<string>",
  "email": "<string>",
  "from_address": "<string>",
  "from_name": "<string>",
  "host": "<string>",
  "id": 123,
  "mailchimp_api": "<string>",
  "name": "<string>",
  "organization": "<string>",
  "password": "<string>",
  "privateKey": "<string>",
  "publicKey": "<string>",
  "username": "<string>",
  "website": "<string>"
}
'
import requests

url = "https://api.helpyousponsor.com/v1/integrations/{name}"

payload = {
"api": "<string>",
"client_id": "<string>",
"email": "<string>",
"from_address": "<string>",
"from_name": "<string>",
"host": "<string>",
"id": 123,
"mailchimp_api": "<string>",
"name": "<string>",
"organization": "<string>",
"password": "<string>",
"privateKey": "<string>",
"publicKey": "<string>",
"username": "<string>",
"website": "<string>"
}
headers = {
"X-HYS-API-Key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'X-HYS-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
api: '<string>',
client_id: '<string>',
email: '<string>',
from_address: '<string>',
from_name: '<string>',
host: '<string>',
id: 123,
mailchimp_api: '<string>',
name: '<string>',
organization: '<string>',
password: '<string>',
privateKey: '<string>',
publicKey: '<string>',
username: '<string>',
website: '<string>'
})
};

fetch('https://api.helpyousponsor.com/v1/integrations/{name}', 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.helpyousponsor.com/v1/integrations/{name}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'api' => '<string>',
'client_id' => '<string>',
'email' => '<string>',
'from_address' => '<string>',
'from_name' => '<string>',
'host' => '<string>',
'id' => 123,
'mailchimp_api' => '<string>',
'name' => '<string>',
'organization' => '<string>',
'password' => '<string>',
'privateKey' => '<string>',
'publicKey' => '<string>',
'username' => '<string>',
'website' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-HYS-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.helpyousponsor.com/v1/integrations/{name}"

payload := strings.NewReader("{\n \"api\": \"<string>\",\n \"client_id\": \"<string>\",\n \"email\": \"<string>\",\n \"from_address\": \"<string>\",\n \"from_name\": \"<string>\",\n \"host\": \"<string>\",\n \"id\": 123,\n \"mailchimp_api\": \"<string>\",\n \"name\": \"<string>\",\n \"organization\": \"<string>\",\n \"password\": \"<string>\",\n \"privateKey\": \"<string>\",\n \"publicKey\": \"<string>\",\n \"username\": \"<string>\",\n \"website\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("X-HYS-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.post("https://api.helpyousponsor.com/v1/integrations/{name}")
.header("X-HYS-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"api\": \"<string>\",\n \"client_id\": \"<string>\",\n \"email\": \"<string>\",\n \"from_address\": \"<string>\",\n \"from_name\": \"<string>\",\n \"host\": \"<string>\",\n \"id\": 123,\n \"mailchimp_api\": \"<string>\",\n \"name\": \"<string>\",\n \"organization\": \"<string>\",\n \"password\": \"<string>\",\n \"privateKey\": \"<string>\",\n \"publicKey\": \"<string>\",\n \"username\": \"<string>\",\n \"website\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.helpyousponsor.com/v1/integrations/{name}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-HYS-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"api\": \"<string>\",\n \"client_id\": \"<string>\",\n \"email\": \"<string>\",\n \"from_address\": \"<string>\",\n \"from_name\": \"<string>\",\n \"host\": \"<string>\",\n \"id\": 123,\n \"mailchimp_api\": \"<string>\",\n \"name\": \"<string>\",\n \"organization\": \"<string>\",\n \"password\": \"<string>\",\n \"privateKey\": \"<string>\",\n \"publicKey\": \"<string>\",\n \"username\": \"<string>\",\n \"website\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "message": "<string>"
}
{
"error": "<string>"
}

Authorizations

X-HYS-API-Key
string
header
required

API key generated from Developer Settings. Format: hys_...

Path Parameters

name
string
required

The name of the integration to edit

Body

application/json

Integration details

api
string
client_id
string
email
string
from_address
string
from_name
string
host
string
id
integer
mailchimp_api
string
name
string
organization
string
password
string
privateKey
string
publicKey
string
username
string
website
string

Response

Successful operation

message
string