Reset PDF Template to Default
POST/api/pdf-templates/:id/reset
Resets a PDF template back to its default content and records the reset as a new version so the prior content can still be restored.
settings:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
What "default" means depends on the template: a store's own copy resets to the account's default template for that type, so a global customisation is not thrown away for one store; the default template itself resets to the built-in content. The reset_target field on the template says which one applies before the reset is run — global or default.
Authentication: Personal Access Token (sent as a Bearer token) with the settings scope (write access).
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.