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

Update path draft

PATCH /api/v2/paths/:slug - Updates draft fields / path_json for the path. Send at least one recognized field.

PATCH/api/v2/paths/:slug

Updates draft fields / path_json for the path. Send at least one recognized field.

Required scope: paths (or *).

Path parameters

NameRequiredDescription
slugYesPath slug

JSON body

NameRequiredDescription
labelNoDisplay label
path_jsonNoDraft path JSON
 
curl -s -X PATCH -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "label": "Medicare Quiz (updated)",
  "path_json": {
    "pages": [
      {
        "id": "welcome",
        "title": "Welcome"
      },
      {
        "id": "zip",
        "title": "ZIP code"
      }
    ],
    "logic": {},
    "settings": {
      "theme": "default"
    }
  }
}' \
  "https://benefitpath.com/api/v2/paths/medicare-quiz"
{
  "success": true,
  "path": {
    "slug": "medicare-quiz",
    "label": "Medicare Quiz (updated)"
  }
}

See Errors for the standard error envelope and rate limits.