curl --request PATCH \
--url https://api-sandbox.endl.io/api/v0/webhooks/subscriptions/{id} \
--header 'API-KEY: <api-key>' \
--header 'Api-Version: <api-version>' \
--header 'Content-Type: application/json' \
--data '
{
"status": "PAUSED",
"eventFilter": [
"payout.completed"
]
}
'import requests
url = "https://api-sandbox.endl.io/api/v0/webhooks/subscriptions/{id}"
payload = {
"status": "PAUSED",
"eventFilter": ["payout.completed"]
}
headers = {
"Api-Version": "<api-version>",
"API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'Api-Version': '<api-version>',
'API-KEY': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({status: 'PAUSED', eventFilter: ['payout.completed']})
};
fetch('https://api-sandbox.endl.io/api/v0/webhooks/subscriptions/{id}', 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-sandbox.endl.io/api/v0/webhooks/subscriptions/{id}",
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([
'status' => 'PAUSED',
'eventFilter' => [
'payout.completed'
]
]),
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"Api-Version: <api-version>",
"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://api-sandbox.endl.io/api/v0/webhooks/subscriptions/{id}"
payload := strings.NewReader("{\n \"status\": \"PAUSED\",\n \"eventFilter\": [\n \"payout.completed\"\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Api-Version", "<api-version>")
req.Header.Add("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-sandbox.endl.io/api/v0/webhooks/subscriptions/{id}")
.header("Api-Version", "<api-version>")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"PAUSED\",\n \"eventFilter\": [\n \"payout.completed\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.endl.io/api/v0/webhooks/subscriptions/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Api-Version"] = '<api-version>'
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"status\": \"PAUSED\",\n \"eventFilter\": [\n \"payout.completed\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"message": "Subscription updated",
"status": "SUCCESS",
"data": {
"id": "2b1e8f40-3c9a-4d21-9f7e-6a1c0b5d2e34",
"deliveryMode": "PUSH",
"target": "https://api.acme.com/webhooks/endl",
"eventFilter": [
"payout.completed"
],
"schemaVersion": "2026-09.1",
"status": "PAUSED",
"secretHint": "whsec_…5RtBw",
"createdOn": "2026-09-02T12:34:56.789Z"
},
"errors": []
}{
"code": 400,
"message": "the target URL cannot be changed; delete this subscription and create a new one",
"status": "ERROR",
"data": null,
"errors": [
{
"code": "ERRWHK_1005",
"message": "the target URL cannot be changed; delete this subscription and create a new one",
"field": null
}
]
}{
"code": 401,
"message": "Authentication failed",
"status": "ERROR",
"data": null,
"errors": [
{
"code": "ERRCORE_1004",
"message": "Authentication failed",
"field": null
}
]
}{
"code": 403,
"message": "Access denied",
"status": "ERROR",
"data": null,
"errors": [
{
"code": "ERRCORE_1005",
"message": "Access denied",
"field": null
}
]
}{
"code": 404,
"message": "subscription not found",
"status": "ERROR",
"data": null,
"errors": [
{
"code": "ERRWHK_1000",
"message": "subscription not found",
"field": null
}
]
}{
"code": 409,
"message": "active subscription limit reached",
"status": "ERROR",
"data": null,
"errors": [
{
"code": "ERRWHK_1003",
"message": "active subscription limit reached",
"field": null
}
]
}{
"code": 429,
"message": "Rate limit exceeded",
"status": "ERROR",
"data": null,
"errors": [
{
"code": "ERRCORE_1006",
"message": "Rate limit exceeded",
"field": null
}
]
}{
"code": 502,
"message": "Upstream webhook service error",
"status": "ERROR",
"data": null,
"errors": [
{
"code": "ERRWHK_1900",
"message": "Upstream webhook service error",
"field": null
}
]
}Update subscription
A partial update — a null or omitted field is left unchanged. You can change the status and the event filter.
The target URL is immutable. A request that includes target is rejected. To send events somewhere else, delete the subscription and create a new one, which issues a fresh signing secret. This is deliberate: it stops a compromised key from silently repointing a live, signed event stream at an attacker.
curl --request PATCH \
--url https://api-sandbox.endl.io/api/v0/webhooks/subscriptions/{id} \
--header 'API-KEY: <api-key>' \
--header 'Api-Version: <api-version>' \
--header 'Content-Type: application/json' \
--data '
{
"status": "PAUSED",
"eventFilter": [
"payout.completed"
]
}
'import requests
url = "https://api-sandbox.endl.io/api/v0/webhooks/subscriptions/{id}"
payload = {
"status": "PAUSED",
"eventFilter": ["payout.completed"]
}
headers = {
"Api-Version": "<api-version>",
"API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'Api-Version': '<api-version>',
'API-KEY': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({status: 'PAUSED', eventFilter: ['payout.completed']})
};
fetch('https://api-sandbox.endl.io/api/v0/webhooks/subscriptions/{id}', 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-sandbox.endl.io/api/v0/webhooks/subscriptions/{id}",
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([
'status' => 'PAUSED',
'eventFilter' => [
'payout.completed'
]
]),
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"Api-Version: <api-version>",
"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://api-sandbox.endl.io/api/v0/webhooks/subscriptions/{id}"
payload := strings.NewReader("{\n \"status\": \"PAUSED\",\n \"eventFilter\": [\n \"payout.completed\"\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Api-Version", "<api-version>")
req.Header.Add("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-sandbox.endl.io/api/v0/webhooks/subscriptions/{id}")
.header("Api-Version", "<api-version>")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"PAUSED\",\n \"eventFilter\": [\n \"payout.completed\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.endl.io/api/v0/webhooks/subscriptions/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Api-Version"] = '<api-version>'
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"status\": \"PAUSED\",\n \"eventFilter\": [\n \"payout.completed\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"message": "Subscription updated",
"status": "SUCCESS",
"data": {
"id": "2b1e8f40-3c9a-4d21-9f7e-6a1c0b5d2e34",
"deliveryMode": "PUSH",
"target": "https://api.acme.com/webhooks/endl",
"eventFilter": [
"payout.completed"
],
"schemaVersion": "2026-09.1",
"status": "PAUSED",
"secretHint": "whsec_…5RtBw",
"createdOn": "2026-09-02T12:34:56.789Z"
},
"errors": []
}{
"code": 400,
"message": "the target URL cannot be changed; delete this subscription and create a new one",
"status": "ERROR",
"data": null,
"errors": [
{
"code": "ERRWHK_1005",
"message": "the target URL cannot be changed; delete this subscription and create a new one",
"field": null
}
]
}{
"code": 401,
"message": "Authentication failed",
"status": "ERROR",
"data": null,
"errors": [
{
"code": "ERRCORE_1004",
"message": "Authentication failed",
"field": null
}
]
}{
"code": 403,
"message": "Access denied",
"status": "ERROR",
"data": null,
"errors": [
{
"code": "ERRCORE_1005",
"message": "Access denied",
"field": null
}
]
}{
"code": 404,
"message": "subscription not found",
"status": "ERROR",
"data": null,
"errors": [
{
"code": "ERRWHK_1000",
"message": "subscription not found",
"field": null
}
]
}{
"code": 409,
"message": "active subscription limit reached",
"status": "ERROR",
"data": null,
"errors": [
{
"code": "ERRWHK_1003",
"message": "active subscription limit reached",
"field": null
}
]
}{
"code": 429,
"message": "Rate limit exceeded",
"status": "ERROR",
"data": null,
"errors": [
{
"code": "ERRCORE_1006",
"message": "Rate limit exceeded",
"field": null
}
]
}{
"code": 502,
"message": "Upstream webhook service error",
"status": "ERROR",
"data": null,
"errors": [
{
"code": "ERRWHK_1900",
"message": "Upstream webhook service error",
"field": null
}
]
}Authorizations
Your partner API key. Requires the webhooks permission, or events for the PULL feed.
Headers
The API version this request targets. Required on every /api/v0/* call. Format YYYY-MM.<release>; 2026-09.1 is the latest. The version that served the request is echoed back on the response. Missing, malformed or unsupported values are rejected with 400.
^\d{4}-\d{2}\.\d+$Path Parameters
The subscription's UUID.