---
title: "Complete path journey with provided ID"
method: PATCH
path: "/api/v2/path_journeys/{id}/complete"
tags: ["Path Journeys"]
---

# Complete path journey with provided ID

`PATCH /api/v2/path_journeys/{id}/complete`

## Request

- Base URL: `https://yournation.nationbuilder.com`
- URL: `https://yournation.nationbuilder.com/api/v2/path_journeys/{id}/complete`
- Auth: HTTP bearer

Marks the path journey as completed, optionally recording a completion reason.

## Path parameters

- `id` string, required

## Query parameters

- `path_journey_status_change_id` string
- `include` PathJourneySideloadValues[]
- `fields[path_journeys]` PathJourneyFieldValues[]

## Response `200`

The completed path journey.

- PathJourneyShowResponse: The JSON:API top-level document shape for responses returning a single resource under the data member.
  - `data` object, required: A JSON:API resource identifier object, the type/id pair that uniquely identifies a single resource.
    - `id` string, required: Unique identifier of the resource.
    - `type` 'path_journeys', required: The JSON:API resource type.
    - `attributes` object: The read-only attributes of a path_journey.
      - `current_step_due_date` string, date-time, nullable: When the current step is due.
      - `current_step_id` string, nullable: The ID of the current step.
      - `current_step_point_person_id` string, nullable: The point person of the current step.
      - `description` string, nullable: This is the description on the signup's path.
      - `due_date` string, date-time, nullable: When the path is due to be completed.
      - `path_id` string, nullable: The associated path.
      - `point_person_id` string, nullable: The point person of this path journey.
      - `signup_id` string, nullable: The signup assigned to the path journey
      - `value_amount` string, float, nullable: Values are enabled by the path and assigned to the path journey.
      - `created_at` string, date-time
      - `ended_at` string, date-time, nullable: When the path ended.
      - `journey_status` 'active' | 'completed' | 'abandoned' | 'deleted' | 'null', nullable: The current path journey status.
      - `last_moved_at` string, date-time, nullable: The last time the signup moved along the path journey.
      - `path_journey_status_change_id` string, nullable: The ID of the status change.
      - `updated_at` string, date-time
  - `included` Resource[]: Sideloaded resources requested via the include query parameter. Each entry is a full resource object whose shape is documented under its own resource type.
    - `id` string, required: Unique identifier of the resource.
    - `type` string, required: The JSON:API resource type.
    - `attributes` object: The attributes of the resource, as documented for its resource type.
    - `relationships` object: References from this resource to other resources in the document.
  - `meta` object: Non-standard information about the document. Empty unless the endpoint has metadata to convey.

## Other responses

- `400`: The request body or query parameters are invalid, such as an unknown attribute, filter, filter operator, sort field, or sideload.
- `401`: The access token is missing, expired, or not authorized to access this resource.
- `404`: No resource exists with the provided ID.
- `429`: The access token has exceeded its request quota for the current rate-limit window.

## Changes

- **2026-11-05** `d5c88ca497ac`: 6 breaking, 6 info
  - for the `query` request parameter `fields[path_journeys]`, default value `` was added
  - for the `query` request parameter `include`, default value `` was added
  - for the `query` request parameter `fields[path_journeys]`, the type changed from `string` to `array`
  - for the `query` request parameter `include`, the type changed from `string` to `array`
  - …8 more

[Operation history](https://skmtc.dev/nationbuilder/apis/nationbuilder-v2-api/changes/api/v2/path_journeys/:id/complete/patch.md)

---

[API](https://skmtc.dev/nationbuilder/apis/nationbuilder-v2-api.md) - [All operations](https://skmtc.dev/nationbuilder/apis/nationbuilder-v2-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nationbuilder/apis/nationbuilder-v2-api/revisions/d5c88ca497ac?raw)