Skip to main content
PUT
/
contests
/
settings
Update contest settings
curl --request PUT \
  --url https://www.renovationfind.com/rest-api-v1/contests/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "editType": "PAUSE_CURRENT_DRIPS_IN_PIPELINE",
  "newValue": true
}
'
import requests

url = "https://www.renovationfind.com/rest-api-v1/contests/settings"

payload = {
    "editType": "PAUSE_CURRENT_DRIPS_IN_PIPELINE",
    "newValue": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({editType: 'PAUSE_CURRENT_DRIPS_IN_PIPELINE', newValue: true})
};

fetch('https://www.renovationfind.com/rest-api-v1/contests/settings', 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://www.renovationfind.com/rest-api-v1/contests/settings",
  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([
    'editType' => 'PAUSE_CURRENT_DRIPS_IN_PIPELINE',
    'newValue' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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 := "https://www.renovationfind.com/rest-api-v1/contests/settings"

	payload := strings.NewReader("{\n  \"editType\": \"PAUSE_CURRENT_DRIPS_IN_PIPELINE\",\n  \"newValue\": true\n}")

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

	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://www.renovationfind.com/rest-api-v1/contests/settings")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"editType\": \"PAUSE_CURRENT_DRIPS_IN_PIPELINE\",\n  \"newValue\": true\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://www.renovationfind.com/rest-api-v1/contests/settings")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"editType\": \"PAUSE_CURRENT_DRIPS_IN_PIPELINE\",\n  \"newValue\": true\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "message": "<string>"
}
{
  "success": false,
  "error": "<string>"
}
{
  "success": false,
  "error": "<string>"
}
{
  "success": false,
  "error": "Rate limit exceeded. Maximum 250 requests per 5 minutes. Please retry later."
}

Authorizations

​
Authorization
string
header
required

JWT token issued from the RenovationFind Manager Portal

Body

application/json
​
editType
enum<string>
required

Which setting to toggle:

  • PAUSE_CURRENT_DRIPS_IN_PIPELINE — pause notifications for existing drip participants
  • PAUSE_VENDOR_CONTEST_DRIPPING_FROM_CFS — pause new CFS records from entering contests
Available options:
PAUSE_CURRENT_DRIPS_IN_PIPELINE,
PAUSE_VENDOR_CONTEST_DRIPPING_FROM_CFS
​
newValue
boolean
required

The new value for the setting (true = paused, false = active)

Response

Settings updated

​
success
boolean
Example:

true

​
message
string