Start free trial

Update recurring template

PUT/api/v1/recurring/{template_id}

Update an existing recurring template.

Operation ID: update_recurring_template_api_v1_recurring__template_id__put·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

template_idstringrequired

Request body

Schema: RecurringTemplateUpdate

namestring

Updated name

currencystring

Updated currency (USD, CAD, AUD, EUR, or GBP)

frequencyFrequencyEnum

Updated frequency

days_until_dueinteger

Updated days until due

day_of_monthinteger

Updated day of month (1-31). Only applies to monthly/quarterly/annually frequencies. If the day doesn't exist in a month, generates on the last day instead.

day_of_weekinteger

Updated day of week (0=Monday, 6=Sunday). Only applies to weekly/biweekly frequencies.

end_datestring · date

Updated end date. Whichever of end_date or max_occurrences is reached first stops generation.

max_occurrencesinteger

Updated max occurrences. Whichever of end_date or max_occurrences is reached first stops generation.

notesstring

Updated notes

template_dataobject

Updated template data

auto_sendboolean

Updated auto-send setting

customer_idstring

Updated customer ID (only for invoice templates)

vendor_idstring

Updated vendor ID (only for bill templates)

Responses

200Successful Response

Schema: SuccessEnvelope_RecurringTemplateResponse_

successboolean
messagestring
codestring
dataRecurringTemplateResponse

400Bad Request - Invalid input

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError
5 fields
locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject