NAnationbuilder
Path Journeys

Complete path journey with provided ID

Changed on

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

patch/api/v2/path_journeys/{id}/complete

Request

  • Base URL
    https://yournation.nationbuilder.com
  • Auth
    HTTP bearer

Path parameters

idstring required

id

Query parameters

path_journey_status_change_idstring

ID of the path journey status change reason to record for this status transition.

includePathJourneySideloadValues[]

Comma-delimited list of sideloaded resources to include as part of the path journey response. See guidance here about sideloading large numbers of resources and pagination.

fields[path_journeys]PathJourneyFieldValues[]

Comma-delimited list of path journey attributes to only return in the response

Response

The completed path journey.

metaobject

Non-standard information about the document. Empty unless the endpoint has metadata to convey.

Example response

{
  "data": {
    "id": "1",
    "type": "path_journeys",
    "attributes": {
      "current_step_due_date": "2019-10-26T10:00:00-04:00",
      "current_step_id": "1",
      "current_step_point_person_id": "1",
      "description": "Added by API",
      "due_date": "2019-10-26T10:00:00-04:00",
      "path_id": "1",
      "point_person_id": "1",
      "signup_id": "1",
      "value_amount": "5.00",
      "created_at": "2019-10-26T10:00:00-04:00",
      "ended_at": "2019-10-26T10:00:00-04:00",
      "journey_status": "active",
      "last_moved_at": "2019-10-26T10:00:00-04:00",
      "path_journey_status_change_id": "1",
      "updated_at": "2019-10-26T10:00:00-04:00"
    }
  },
  "included": [
    {
      "id": "1"
    }
  ]
}

Changes

  • d5c88ca497acRevision changes
    • breaking

      for the query request parameter fields[path_journeys], default value was added

    • breaking

      for the query request parameter include, default value was added

    • breaking

      for the query request parameter fields[path_journeys], the type changed from string to array

    • breaking

      for the query request parameter include, the type changed from string to array

    • breaking

      the response's body type changed from object to no type for status

    • breaking

      removed the required property from the response with the status

    • info

      added subschema #2 to the response body allOf list for the response status

    • info

      media type application/json was changed to a more specific media type application/vnd.api+json for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status