Get Email Template AI Batch
GET/api/store-email-templates/ai-batches/:batch
Returns an AI batch with every proposal, for review. Poll while status is pending or running.
settings:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token. Visible to the batch's creator and to users with the email_templates.update permission (404 otherwise).
Batch status: pending, running, completed, failed, cancelled. total / done count proposals (done = no longer pending). error explains a batch that stopped early.
Proposal status: pending (not processed yet), ready (reviewable), failed (see error; validation lists the checks it failed), accepted (saved to the template), rejected. subject / preheader are null when the template's own are kept (an empty-string preheader removes it). rendered_preview_html is the proposal rendered with sample data, for ready, accepted and rejected proposals (null while pending or when it failed).
Request
Responses
- 200
- 401
- 403
- 404
- 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
Response Headers
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.