STstuut
outreach-workflows

Create a statement schedule for a workflow

The schedule controls when recurring account statements are sent for partners on the workflow.

post/v2/outreach-workflows/{workflow_id}/statement-schedule

Request

  • Base URL
    https://api.stuut.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

workflow_idstring required

Request body

frequency'weekly' | 'biweekly' | 'monthly' required
day_of_weekinteger nullable
day_of_monthinteger nullable
week_of_monthinteger nullable
email_templatestring required

Email template ID

auto_sendboolean
attach_xlsboolean
include_credit_memosboolean
include_disputed_itemsboolean
ccstring[]
bccstring[]
cc_secondary_contactsboolean
external_roles_to_ccExternalContactType[]
internal_roles_to_ccInternalContactType[]

Response

Successful Response

created_atstring date-time required
modified_atstring date-time nullable required
idstring required
is_activeboolean required
frequency'weekly' | 'biweekly' | 'monthly' required
day_of_weekinteger nullable required

Day of week (0=Monday, 6=Sunday). Required for WEEKLY/BIWEEKLY.

day_of_monthinteger nullable required

Day of month (1-31). Required for MONTHLY day-of-month mode. Falls back to last day if month is shorter.

week_of_monthinteger nullable required

Week occurrence (1-5, where 5=last). Used with day_of_week for monthly day-of-week mode.

biweekly_anchor_datestring date nullable required

Anchor date for biweekly cadence calculation. Required for BIWEEKLY.

include_credit_memosboolean required
include_disputed_itemsboolean required
auto_sendboolean required
attach_xlsboolean required

If True, always attach an XLS to the scheduled statement, ignoring partner.is_xls_attachments_enabled.

ccstring[] nullable required
bccstring[] nullable required
cc_secondary_contactsboolean required
external_roles_to_ccstring[] nullable required
internal_roles_to_ccstring[] nullable required
objectstring required

String representing the object's type. Objects of the same type share the same value.

Changes

No recorded changes to this operation across all 1 revision of this API.