Skip to content

[GG-1820] Document the SEC lifecycle API - #129

Open
dgra wants to merge 1 commit into
mainfrom
GG-1820-sec-lifecycle-docs
Open

dgra wants to merge 1 commit into
mainfrom
GG-1820-sec-lifecycle-docs

Conversation

@dgra

@dgra dgra commented Sep 24, 2026 •

Copy link
Copy Markdown
Member

Addresses: 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.

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.
@dgra dgra self-assigned this Sep 24, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant