Skip to main content
PUT
/
api
/
admin
/
settings
/
email-providers
cURL
curl --request PUT \
  --url http://localhost:3001/api/admin/settings/email-providers \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspaceId": "<string>",
  "config": {
    "type": "MailChimp",
    "apiKey": "<string>",
    "webhookKey": "<string>"
  },
  "setDefault": true
}
'
import requests

url = "http://localhost:3001/api/admin/settings/email-providers"

payload = {
    "workspaceId": "<string>",
    "config": {
        "type": "MailChimp",
        "apiKey": "<string>",
        "webhookKey": "<string>"
    },
    "setDefault": True
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'PUT',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    workspaceId: '<string>',
    config: {type: 'MailChimp', apiKey: '<string>', webhookKey: '<string>'},
    setDefault: true
  })
};

fetch('http://localhost:3001/api/admin/settings/email-providers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3001",
  CURLOPT_URL => "http://localhost:3001/api/admin/settings/email-providers",
  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([
    'workspaceId' => '<string>',
    'config' => [
        'type' => 'MailChimp',
        'apiKey' => '<string>',
        'webhookKey' => '<string>'
    ],
    'setDefault' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$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 := "http://localhost:3001/api/admin/settings/email-providers"

	payload := strings.NewReader("{\n  \"workspaceId\": \"<string>\",\n  \"config\": {\n    \"type\": \"MailChimp\",\n    \"apiKey\": \"<string>\",\n    \"webhookKey\": \"<string>\"\n  },\n  \"setDefault\": true\n}")

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

	req.Header.Add("Authorization", "<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.put("http://localhost:3001/api/admin/settings/email-providers")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workspaceId\": \"<string>\",\n  \"config\": {\n    \"type\": \"MailChimp\",\n    \"apiKey\": \"<string>\",\n    \"webhookKey\": \"<string>\"\n  },\n  \"setDefault\": true\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:3001/api/admin/settings/email-providers")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"workspaceId\": \"<string>\",\n  \"config\": {\n    \"type\": \"MailChimp\",\n    \"apiKey\": \"<string>\",\n    \"webhookKey\": \"<string>\"\n  },\n  \"setDefault\": true\n}"

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

Authorizations

Authorization
string
header
required

Body

application/json
workspaceId
string
required
config
object
required
setDefault
boolean

Response

An empty String

An empty String