Dunning Campaigns
Update Campaign Step
Update an existing step in a dunning campaign.
PUT
/
v1
/
dunning-campaigns
/
steps
/
{id}
Update a dunning campaign step
curl --request PUT \
--url https://billing.example.com/v1/dunning-campaigns/steps/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"step_order": 123,
"delay_hours": 123,
"template_name": "<string>",
"subject": "<string>",
"body": "<string>",
"is_payment_wall": true
}
'import requests
url = "https://billing.example.com/v1/dunning-campaigns/steps/{id}"
payload = {
"step_order": 123,
"delay_hours": 123,
"template_name": "<string>",
"subject": "<string>",
"body": "<string>",
"is_payment_wall": 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({
step_order: 123,
delay_hours: 123,
template_name: '<string>',
subject: '<string>',
body: JSON.stringify('<string>'),
is_payment_wall: true
})
};
fetch('https://billing.example.com/v1/dunning-campaigns/steps/{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://billing.example.com/v1/dunning-campaigns/steps/{id}",
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([
'step_order' => 123,
'delay_hours' => 123,
'template_name' => '<string>',
'subject' => '<string>',
'body' => '<string>',
'is_payment_wall' => 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://billing.example.com/v1/dunning-campaigns/steps/{id}"
payload := strings.NewReader("{\n \"step_order\": 123,\n \"delay_hours\": 123,\n \"template_name\": \"<string>\",\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"is_payment_wall\": 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://billing.example.com/v1/dunning-campaigns/steps/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"step_order\": 123,\n \"delay_hours\": 123,\n \"template_name\": \"<string>\",\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"is_payment_wall\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://billing.example.com/v1/dunning-campaigns/steps/{id}")
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 \"step_order\": 123,\n \"delay_hours\": 123,\n \"template_name\": \"<string>\",\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"is_payment_wall\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"step_order": 123,
"channel": "email",
"delay_hours": 123,
"template_name": "<string>",
"subject": "<string>",
"body": "<string>",
"is_payment_wall": true,
"created_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "BAD_REQUEST",
"message": "<string>"
}
}{
"error": {
"code": "BAD_REQUEST",
"message": "<string>"
}
}Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The dunning step ID (dstep_ prefix). |
Body Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
day_offset | integer | No | Number of days after the initial payment failure to execute this step. |
channel | string | No | Delivery channel. One of email, sms, or payment_wall. |
template_id | string | No | ID of a pre-configured message template. |
subject | string | No | Subject line for the message. |
body | string | No | Message body content. Supports Liquid template variables. |
Example Request
curl -X PUT "https://api.recurso.dev/v1/dunning-campaigns/steps/dstep_5rMt8wVn3aZs" \
-H "Authorization: Bearer rsk_live_9f8a7b6c5d4e3f2a1b0c" \
-H "Content-Type: application/json" \
-d '{
"day_offset": 2,
"subject": "Urgent: Your payment needs attention",
"body": "Hi {{ customer.first_name }}, your payment of {{ amount_due }} for {{ subscription.plan_name }} could not be processed. Please update your payment method at {{ update_payment_url }} to avoid service interruption."
}'
Response
{
"id": "dstep_5rMt8wVn3aZs",
"object": "dunning_step",
"campaign_id": "dc_8mKp3vRn2wXq",
"day_offset": 2,
"channel": "email",
"template_id": null,
"subject": "Urgent: Your payment needs attention",
"body": "Hi {{ customer.first_name }}, your payment of {{ amount_due }} for {{ subscription.plan_name }} could not be processed. Please update your payment method at {{ update_payment_url }} to avoid service interruption.",
"is_active": true,
"created_at": "2026-06-23T10:35:00Z",
"updated_at": "2026-06-23T16:10:00Z"
}
You only need to include the fields you want to update. Omitted fields retain their current values.
Authorizations
Tenant API key obtained from POST /auth/register or POST /v1/developer/keys.
Path Parameters
Body
application/json
⌘I
Update a dunning campaign step
curl --request PUT \
--url https://billing.example.com/v1/dunning-campaigns/steps/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"step_order": 123,
"delay_hours": 123,
"template_name": "<string>",
"subject": "<string>",
"body": "<string>",
"is_payment_wall": true
}
'import requests
url = "https://billing.example.com/v1/dunning-campaigns/steps/{id}"
payload = {
"step_order": 123,
"delay_hours": 123,
"template_name": "<string>",
"subject": "<string>",
"body": "<string>",
"is_payment_wall": 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({
step_order: 123,
delay_hours: 123,
template_name: '<string>',
subject: '<string>',
body: JSON.stringify('<string>'),
is_payment_wall: true
})
};
fetch('https://billing.example.com/v1/dunning-campaigns/steps/{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://billing.example.com/v1/dunning-campaigns/steps/{id}",
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([
'step_order' => 123,
'delay_hours' => 123,
'template_name' => '<string>',
'subject' => '<string>',
'body' => '<string>',
'is_payment_wall' => 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://billing.example.com/v1/dunning-campaigns/steps/{id}"
payload := strings.NewReader("{\n \"step_order\": 123,\n \"delay_hours\": 123,\n \"template_name\": \"<string>\",\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"is_payment_wall\": 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://billing.example.com/v1/dunning-campaigns/steps/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"step_order\": 123,\n \"delay_hours\": 123,\n \"template_name\": \"<string>\",\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"is_payment_wall\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://billing.example.com/v1/dunning-campaigns/steps/{id}")
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 \"step_order\": 123,\n \"delay_hours\": 123,\n \"template_name\": \"<string>\",\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"is_payment_wall\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"step_order": 123,
"channel": "email",
"delay_hours": 123,
"template_name": "<string>",
"subject": "<string>",
"body": "<string>",
"is_payment_wall": true,
"created_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "BAD_REQUEST",
"message": "<string>"
}
}{
"error": {
"code": "BAD_REQUEST",
"message": "<string>"
}
}