Pause recurring template

POST/api/v1/recurring/{template_id}/pause

Pause an active recurring template. No new documents will be generated until resumed.

Operation ID: pause_recurring_template_api_v1_recurring__template_id__pause_post·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

Responses

201Successful 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

Code samples

POST/api/v1/recurring/{template_id}/pause

bash

curl -X POST 'https://api.ondayzero.com/api/v1/recurring/{template_id}/pause' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'