Update recurring template

PUT/api/v1/recurring/{template_id}

Update an existing recurring template.

Operation ID: update_recurring_template·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_idstring · uuidrequired

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)
contract_idstring: Updated contract ID (invoice templates only) — used to link a recurring schedule to a contract as a follow-up call after creation, the same pattern the invoice-creation endpoint uses for Invoices.contract_id (see ContractInvoiceModal).

Responses

200Successful Response

Schema: SuccessEnvelope_RecurringTemplateResponse_

successboolean
messagestring
codestring
dataRecurringTemplateResponse

400Bad Request - Invalid input

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

401Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

403Forbidden - Insufficient permissions

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

404Not Found - Resource does not exist

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

422Validation Error

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

Code samples

PUT/api/v1/recurring/{template_id}

bash

curl -X PUT 'https://api.ondayzero.com/api/v1/recurring/{template_id}' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "days_until_due": 30,
  "name": "Monthly Rent - Updated",
  "template_data": {
    "amount": 375000,
    "description": "Office rent for 456 New St"
  }
}'