Pardon our mess These API docs are a work in progress. Endpoints, examples, and behavior may change as we continue to develop the Partner API v2.

Partner API

Publish path

POST /api/v2/paths/:slug/publish - Publishes the current draft as a new live version.

POST/api/v2/paths/:slug/publish

Publishes the current draft as a new live version.

Required scope: paths (or *).

Path parameters

NameRequiredDescription
slugYesPath slug

JSON body

NameRequiredDescription
publish_noteNoOptional publish note (max 255)
 
curl -s -X POST -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "publish_note": "Launch v4 with ZIP step"
}' \
  "https://benefitpath.com/api/v2/paths/medicare-quiz/publish"
{
  "success": true,
  "path": { "slug": "medicare-quiz", "version": "4" }
}

See Errors for the standard error envelope and rate limits.