docs(transmissions): document test-send endpoint#585
Draft
danielfsousa wants to merge 1 commit into
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the new SparkPost test-send endpoint (
POST /v1/transmissions/test-send) incontent/api/transmissions.apib.The endpoint lets a user send a test email of a stored template (draft or published version) to up to 5 recipients — a scoped alternative to creating a full transmission, built for the template-editing workflow.
What was added
## Send a Test Email [/v1/transmissions/test-send]with a### Send a Test Email [POST]action, placed after the RFC822 content section and before Scheduled Transmissions.templates/test-sendgrant (held by the Templates, Developer, and Subaccount Developer roles, and custom users with the Templates policy; full Transmissions: Read/Write grant holders can also call it). Web-app sessions only for now — cannot be assigned to API keys yet.template_id,draft,recipientsas plain string array,substitution_data,metadata,options), with the option restrictions (skip_suppression/start_timerejected,sandboxignored/auto).+ Request/+ Response 200/+ Response 422examples.Context
Merge timing
These docs should merge only once the feature is fully rolled out — transmissions-api#465 and public-api-proxy#156 deployed, and the access grant (access#125) released.
Validation
Parsed
content/api/transmissions.apibwith the repo'sfury+fury-adapter-apib-parsertoolchain (same as thegatsby-transformer-api-blueprintplugin): 0 errors, and the identical warning set as the pre-change baseline (no new warnings introduced). Full Gatsby build not run (too heavy for a content-only change).