Create dunning campaign

POST

/v1/dunning_campaigns/

Create a new dunning campaign.

Request Body ^required

DunningCampaignCreate

Schema for creating a dunning campaign.

object

code

required

Code

string

>= 1 characters <= 255 characters

name

required

Name

string

>= 1 characters <= 255 characters

description

Any of:

string

string

null

null

max_attempts

Max Attempts

integer

default: 3 >= 1

days_between_attempts

Days Between Attempts

integer

default: 3 >= 1

bcc_emails

Bcc Emails

Array<string>

status

Status

string

default: active /^(active|inactive)$/

thresholds

Thresholds

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

number

string

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

Responses

201

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

string

null

null

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

401

Unauthorized

409

Dunning campaign with this code already exists

422

Validation error