Update Template

patch

https://{your-totality-url}.com/api/templates/{templateUuid}

Update information on a template. Permission: Update Templates

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

templateUuid

string

required

The UUID of the template.

Body Params

afterDays

int32

Days to wait before sending.

afterHours

int32

Hours to wait before sending.

afterMinutes

int32

Minutes to wait before sending.

atHour

int32

Hour of day to send (0-23).

consecutiveNsfCount

integer | null

1 to 100

Optional. Fires the template only when the loan's consecutive NSF count equals this value. Only applied when eventClass is NonSufficientFundFeeEvent. Leave null to fire on every NSF.

daysPrior

int32

Days before the event to send.

deliveryMethod

string

enum

How the communication is delivered (Email, Text).

Allowed:

eventClass

string

enum

Event that triggers this template.

isEnabled

boolean

Whether the template is active.

isImmediate

boolean

Whether to send immediately.

loanGroups

array of strings

Defaults to []

Loan groups this template applies to (array of UUIDs).

loanGroups

name

string

Name of the resource.

onlyIfNoActiveLoans

boolean

Defaults to false

Only send notification if the customer has no other active loans. Only applicable when eventClass is LoanPaidOffEvent.

settlementFilter

string | null

enum

Filter Loan Paid Off notifications by settlement status. Use exclude_settled to skip loans paid via settlement offer, or only_settled to send only for settled payoffs. Only applicable when eventClass is LoanPaidOffEvent.

Allowed:

paymentFrequency

string

enum

How often payments are made (Weekly, Bi-Weekly, Monthly, Semi-Monthly).

Allowed:

schedule

string

enum

When to send (immediately, afterDaysAndHours, afterDaysAtHour, daysPrior).

Allowed:

shouldAttachContract

boolean

Whether to attach the contract PDF.

subject

string

Email subject line.

204204

401401

403403

422422

500500