Validate PDF Template
POST/api/pdf-templates/:id/validate
Validates draft template content against the template type's schema without rendering it. Use this to surface unknown variables, unbalanced sections, and non-blocking warnings before saving.
settings:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Personal Access Token (sent as a Bearer token) with the settings scope (read access).
Fields:
- content (required): the draft markup to validate.
The response data contains ok (true when there are no errors), an errors array, and a warnings array.
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.