Skip to content

Document recent API changes: audience tags, schedule audience check, campaign emails - #133

Closed
wstrinz wants to merge 1 commit into
mainfrom
api-docs-drift-fixes-2026-10
Closed

wstrinz wants to merge 1 commit into
mainfrom
api-docs-drift-fixes-2026-10

Conversation

@wstrinz

@wstrinz wstrinz commented Oct 22, 2026

Copy link
Copy Markdown

Documents changes here:

TL;DR

Brings the REST docs in line with the current v2 API: broadcast audience tags conditions, the schedule audience check, the campaign emails endpoints, and some smaller gaps.

Background

These API changes shipped with updated OpenAPI specs in drip, but the public docs were not updated to match.

Modification

  • _broadcasts.md:
    • Set the audience: documents tags conditions (8 operators, with a table) next to segments. The examples now combine a segment with a tag exclusion.
    • Fetch the audience: the "cannot be expressed" example now uses a type that is still unsupported (actions), and the text explains when unsupported_types is omitted.
    • Schedule: replaces "the audience is not checked here" with the 409 returned when no audience was chosen, and adds its example.
    • include_metrics on list and fetch, the metrics object, and primary_purpose on update.
  • _campaigns.md: new "List all emails in an Email Series Campaign" and "Fetch an email in an Email Series Campaign" sections (GET /v2/:account_id/campaigns/:campaign_id/emails[/:email_id]).
  • _rate_limiting.md: the workflow details limit (2,000 requests per account per hour, then 429 with Retry-After).
  • _tags.md: the "Remove a tag" endpoint line was missing /v2.

Wording comes from drip's controllers, views and docs/api/v2/*_api_spec.yaml on main.

Result

The changes appear on developer.drip.com after the next deploy. _workflows.md is not changed here, to avoid conflicting with #132. The rate limit note can move into the workflow details section once that PR merges.

How to verify/test in production

After make deploy, open https://developer.drip.com/#set-the-audience, #schedule-a-single-email-campaign and #list-all-emails-in-an-email-series-campaign. Check that the new tables and tabs render, and that the in-page links ("Set the audience", "Fetch the audience", "Fetch a workflow's details") go to their sections.

Checklist

  • The PR title contains the JIRA key (if using JIRA).
  • You have manually tested/validated your changes (if applicable).
  • Automatic tests and/or monitoring have been added or updated. (n/a: CI builds the site)
  • Full PR template above has been filled in.

🤖 Generated with Claude Code

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@wstrinz

wstrinz commented Oct 22, 2026

Copy link
Copy Markdown
Author

Split into smaller stacked PRs so each public docs change can be reviewed on its own:

  1. Add the missing /v2 prefix to the remove-a-tag endpoint #134 (remove-a-tag /v2 path)
  2. Document include_metrics and primary_purpose for Single-Email Campaigns #135 (include_metrics + primary_purpose)
  3. Document the 409 when scheduling a Single-Email Campaign with no audience chosen #136 (schedule 409 when no audience was chosen)
  4. Document tags conditions for Single-Email Campaign audiences #137 (audience tags conditions)
  5. Document the Email Series Campaign email list and fetch endpoints #138 (Email Series Campaign email endpoints)

plus #139 (workflow details rate limit, stacked on #132).

🤖 Closed with Claude Code

@wstrinz wstrinz closed this Oct 22, 2026
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