API Reference

Update Template

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

Update information on a template. Permission: Update Templates

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The UUID of the template.

Body Params
int32

Days to wait before sending.

int32

Hours to wait before sending.

int32

Minutes to wait before sending.

int32

Hour of day to send (0-23).

int32

Days before the event to send.

string
enum

How the communication is delivered (Email, Text).

Allowed:
string
enum

Event that triggers this template.

boolean

Whether the template is active.

boolean

Whether to send immediately.

loanGroups
array of strings
Defaults to []

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

loanGroups
string

Name of the resource.

string
enum

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

Allowed:
string
enum

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

Allowed:
boolean

Whether to attach the contract PDF.

string

Email subject line.

tags
array of strings
Defaults to []

Array of tag names associated with the resource.

tags
string
enum

The type or category of the resource.

Allowed:
Headers
string
required
Defaults to application/vnd.totality.v1+json

Must be application/json.

string
required
Defaults to application/json

Must be application/json.

Responses

Updated about 1 month ago

Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated about 1 month ago