Conversation
Addresses: [GG-1820](https://dripcom.atlassian.net/browse/GG-1820) ## Background - A client can create a Single-Email Campaign over the API and send a test of it, but the endpoints that decide who receives it, and that take a scheduled campaign back to draft, have shipped without public documentation. - Publishing these docs is the go-live gate for that work: the REST endpoints are already live on production. ## Modification - Adds a Segments page, read-only. Segments are built in the app; this documents finding one and the `id` the audience endpoint takes. - Documents setting a Single-Email Campaign's audience, including the filter shape, that `[[]]` means everyone, that `segments` with `in` and `not_in` is the whole vocabulary today, and that replacing an existing audience needs `confirm=true`. - Documents reading an audience back, including the case that will be most common for a while: an audience built in the app whose rules have no form here yet, which comes back described rather than as a filter. - Documents unscheduling, including that the send time is not preserved and that a repeat call is safe. ## Result - The SEC lifecycle is documented end to end for the operations that are live: create, set an audience, read it back, unschedule. - Scheduling is not included; it is still in review.
This branch has not been deployed
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.
Addresses: GG-1820
Background
Modification
idthe audience endpoint takes.[[]]means everyone, thatsegmentswithinandnot_inis the whole vocabulary today, and that replacing an existing audience needsconfirm=true.Result