Skip to main content
PATCH
/
shipping-rules
/
rules
/
{rule_id}
Update a shipping rule
curl --request PATCH \
  --url https://panel.sendcloud.sc/api/v3/shipping-rules/rules/{rule_id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "is_active": false
}
'
import requests

url = "https://panel.sendcloud.sc/api/v3/shipping-rules/rules/{rule_id}"

payload = { "is_active": False }
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({is_active: false})
};

fetch('https://panel.sendcloud.sc/api/v3/shipping-rules/rules/{rule_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://panel.sendcloud.sc/api/v3/shipping-rules/rules/{rule_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([
'is_active' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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://panel.sendcloud.sc/api/v3/shipping-rules/rules/{rule_id}"

payload := strings.NewReader("{\n \"is_active\": false\n}")

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

req.Header.Add("Authorization", "Basic <encoded-value>")
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://panel.sendcloud.sc/api/v3/shipping-rules/rules/{rule_id}")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"is_active\": false\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://panel.sendcloud.sc/api/v3/shipping-rules/rules/{rule_id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"is_active\": false\n}"

response = http.request(request)
puts response.read_body
{
  "id": 1,
  "name": "Insure high-value parcels",
  "is_active": true,
  "is_invalid": false,
  "order": 1,
  "updated_at": "2026-06-26T10:15:00Z",
  "criteria": {
    "is_and": true,
    "conditions": [
      {
        "property": "total_order_value",
        "operator": "greater_than",
        "compare_to": "100"
      }
    ]
  },
  "actions": [
    {
      "identifier": "set_insurance",
      "value": "500"
    }
  ]
}
{
"errors": [
{
"id": "<string>",
"links": {
"about": "<string>"
},
"status": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
]
}
{
"errors": [
{
"id": "<string>",
"links": {
"about": "<string>"
},
"status": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
]
}

Authorizations

Authorization
string
header
required

Basic Authentication using API key and secrets is currently the main authentication mechanism.

Path Parameters

rule_id
integer<int64>
required

The unique id of the shipping rule.

Required range: x >= 1
Example:

1

Body

application/json

Payload to update a shipping rule. Omit any field to leave it unchanged.

name
string | null

New name for the rule; omit to leave unchanged.

Maximum string length: 100
is_active
boolean | null

New active flag; omit to leave unchanged.

criteria
RuleCriteriaInput · object | null

Replacement criteria block; omit to keep the existing criteria.

actions
RuleActionInput · object[] | null

Replacement actions list; omit to keep the existing actions.

Response

OK

A shipping rule including its conditions and actions.

id
integer
required

ID of the rule.

Example:

1

name
string
required

Name of the rule.

Example:

"Insure high-value parcels"

is_active
boolean
required

Whether the rule is currently evaluating shipments.

Example:

true

is_invalid
boolean
required

True when the rule cannot be evaluated (e.g. references an unavailable property or action).

Example:

false

order
integer | null

Position in the organization's evaluation order; lower values are evaluated first.

Example:

1

updated_at
string<date-time> | null

Timestamp of the last update to the rule.

Example:

"2026-06-26T10:15:00Z"

criteria
RuleCriteriaDetail · object | null

Criteria that determine when this rule fires.

actions
RuleActionDetail · object[]

Actions executed when the rule fires.