Update organization settings
curl --request PATCH \
--url https://api.collectpure.com/organization/update-organization/v1 \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"vacationMode": true,
"electronicCheckName": "<string>",
"electronicCheckEmail": "[email protected]"
}
'import requests
url = "https://api.collectpure.com/organization/update-organization/v1"
payload = {
"vacationMode": True,
"electronicCheckName": "<string>",
"electronicCheckEmail": "[email protected]"
}
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({
vacationMode: true,
electronicCheckName: '<string>',
electronicCheckEmail: '[email protected]'
})
};
fetch('https://api.collectpure.com/organization/update-organization/v1', 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.collectpure.com/organization/update-organization/v1",
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([
'vacationMode' => true,
'electronicCheckName' => '<string>',
'electronicCheckEmail' => '[email protected]'
]),
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.collectpure.com/organization/update-organization/v1"
payload := strings.NewReader("{\n \"vacationMode\": true,\n \"electronicCheckName\": \"<string>\",\n \"electronicCheckEmail\": \"[email protected]\"\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.collectpure.com/organization/update-organization/v1")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"vacationMode\": true,\n \"electronicCheckName\": \"<string>\",\n \"electronicCheckEmail\": \"[email protected]\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.collectpure.com/organization/update-organization/v1")
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 \"vacationMode\": true,\n \"electronicCheckName\": \"<string>\",\n \"electronicCheckEmail\": \"[email protected]\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"vacationMode": true,
"electronicCheckName": "<string>",
"electronicCheckEmail": "<string>"
}
}Organization API
Update organization settings
Update one or more settings for the authenticated organization. Only the provided fields will be modified. Supports vacation mode, payout method, and electronic check details.
Rate limit: 120 requests burst, 60 requests/minute sustained.
PATCH
/
organization
/
update-organization
/
v1
Update organization settings
curl --request PATCH \
--url https://api.collectpure.com/organization/update-organization/v1 \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"vacationMode": true,
"electronicCheckName": "<string>",
"electronicCheckEmail": "[email protected]"
}
'import requests
url = "https://api.collectpure.com/organization/update-organization/v1"
payload = {
"vacationMode": True,
"electronicCheckName": "<string>",
"electronicCheckEmail": "[email protected]"
}
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({
vacationMode: true,
electronicCheckName: '<string>',
electronicCheckEmail: '[email protected]'
})
};
fetch('https://api.collectpure.com/organization/update-organization/v1', 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.collectpure.com/organization/update-organization/v1",
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([
'vacationMode' => true,
'electronicCheckName' => '<string>',
'electronicCheckEmail' => '[email protected]'
]),
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.collectpure.com/organization/update-organization/v1"
payload := strings.NewReader("{\n \"vacationMode\": true,\n \"electronicCheckName\": \"<string>\",\n \"electronicCheckEmail\": \"[email protected]\"\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.collectpure.com/organization/update-organization/v1")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"vacationMode\": true,\n \"electronicCheckName\": \"<string>\",\n \"electronicCheckEmail\": \"[email protected]\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.collectpure.com/organization/update-organization/v1")
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 \"vacationMode\": true,\n \"electronicCheckName\": \"<string>\",\n \"electronicCheckEmail\": \"[email protected]\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"vacationMode": true,
"electronicCheckName": "<string>",
"electronicCheckEmail": "<string>"
}
}Authorizations
API key for authentication
Body
application/json
Enable or disable vacation mode. When active, listings and offers are hidden from the marketplace.
Default payout method for the organization
Available options:
electronic_check, teller_ach Payee name for electronic check payouts
Maximum string length:
40Payee email for electronic check payouts
Pattern:
^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$Was this page helpful?
⌘I