Repository navigation
Docs: copy the API spec, add text_unchecked, the template check and variable kinds - #37
Merged
Merged
Conversation
… 503 The API spec now describes the check every API v2 send and campaign test goes through before it is sent: content that cannot be rendered is refused with 400, and a check that cannot run right now answers 503 with Retry-After. The errors, sending, template and Test Campaign pages say how to read and retry each answer, and the October changelog lists the change.
farhadhf
changed the title
…ables The API spec now gives each variable of a transactional template a kind: value, condition or list, and a list variable names the fields of its elements. The Transactional templates page explains what to send for each kind with a list example, the Get Template, Get Template Version and Create Template Message pages point to it, and the October changelog lists the change.
farhadhf
changed the title
…able kinds A published template has no draft, so publishing alone makes no new version; the reader has to make an edit and save it first. The kinds table also said a condition takes any value, while an empty value hides the part.
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
1 participant
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.
Copies
openapi.yamlandwebhooks.yamlfrom the server and documents what they add:text_uncheckedcampaign issue on the Campaigns overview.400for content that cannot be rendered, and a503withRetry-Afterwhen the check cannot run right now. Covered on the Errors, Sending, Transactional templates, Idempotency and Test Campaign pages, and in the October changelog.kindof each template variable (value,condition,list) anditem_fieldsfor list variables. A new "Kinds of variables" section on the Transactional templates page, with a list example, linked from Get Template, Get Template Version and Create Template Message, and in the October changelog.The spec copy also brings in description changes: rate-limit
Retry-After, sender and recipient names,bcc, thetoheader, webhook signatures, retry counts, route deliveries, and the sender address on webhook events.Merge after the release.