Skip to content

[GG-1952] Document workflow email content endpoint - #132

Draft
wstrinz wants to merge 1 commit into
mainfrom
api-docs-workflow-email-endpoint
Draft

wstrinz wants to merge 1 commit into
mainfrom
api-docs-workflow-email-endpoint

Conversation

@wstrinz

@wstrinz wstrinz commented Oct 22, 2026 •

Copy link
Copy Markdown

Addresses: GG-1952

Documents changes here:

TL;DR

Documents GET /v2/:account_id/workflows/:workflow_id/emails/:workflow_email_id, and the email object on send_email nodes in workflow details.

Background

drip#31853 added a way to read a workflow email's subject, preheader and bodies over the API, and added email: {id, subject} to send_email action nodes in the workflow details response. Neither is in the public docs yet.

Modification

In source/includes/rest/_workflows.md:

  • New "Fetch a workflow email" section after "Fetch a workflow's details": request examples (cURL, Ruby, JavaScript, in the same style as the details section), an example response, a properties table, and the 404 a mismatched email id returns.
  • Workflow details: the example send_email step now shows email, the node table lists it for actions, and a paragraph explains email.id versus properties.automation_email_id.

Field names and wording come from drip's docs/api/v2/workflow_emails_api_spec.yaml, the workflow_emails/show.json.jbuilder view, and the details serializer.

Result

The endpoint and the new details field appear on developer.drip.com after the next deploy.

How to verify/test in production

After make deploy, open https://developer.drip.com/#fetch-a-workflow-email and check that the section renders with its three language tabs, and that the "Fetch a workflow's details" link from it jumps to the details section.

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

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

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