Skip to content

Update dunning campaign

PUT
/v1/dunning_campaigns/{campaign_id}

Update a dunning campaign.

campaign_id
required
Campaign Id
string format: uuid
DunningCampaignUpdate

Schema for updating a dunning campaign.

object
code
Any of:
string
>= 1 characters <= 255 characters
name
Any of:
string
>= 1 characters <= 255 characters
description
Any of:
string
max_attempts
Any of:
integer
>= 1
days_between_attempts
Any of:
integer
>= 1
bcc_emails
Any of:
Array<string>
status
Any of:
string
/^(active|inactive)$/
thresholds
Any of:
Array<object>
DunningCampaignThresholdCreate

Schema for creating a dunning campaign threshold.

object
currency
required
Currency
string
>= 3 characters <= 3 characters
amount_cents
required
Any of:
number

Successful Response

DunningCampaignResponse

Schema for dunning campaign response.

object
id
required
Id
string format: uuid
organization_id
required
Organization Id
string format: uuid
code
required
Code
string
name
required
Name
string
description
Any of:
string
max_attempts
required
Max Attempts
integer
days_between_attempts
required
Days Between Attempts
integer
bcc_emails
required
Bcc Emails
Array<string>
status
required
Status
string
thresholds
Thresholds
Array<object>
DunningCampaignThresholdResponse

Schema for dunning campaign threshold response.

object
id
required
Id
string format: uuid
dunning_campaign_id
required
Dunning Campaign Id
string format: uuid
currency
required
Currency
string
amount_cents
required
Amount Cents
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time

Unauthorized

Dunning campaign not found

Validation error