NAnationbuilder
Path Steps

Create a path step

Changed on

Creates a path step from given data. If the position you specify is already taken by another step on the path, your step will be placed at that position and that step and the steps following will be re-ordered. If you do not specify a position, the step will be auto-assigned to the last position in the list of path steps for the related path.

post/api/v2/path_steps

Request

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

Request body

Example request

{
  "data": {
    "type": "path_steps",
    "attributes": {
      "default_due_date_interval": "none",
      "default_point_person_id": "1",
      "name": "Attend a fundraiser",
      "path_id": "1",
      "position": 1
    }
  }
}

Response

The newly created path step.

metaobject

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

Example response

{
  "data": {
    "id": "1",
    "type": "path_steps",
    "attributes": {
      "default_due_date_interval": "none",
      "default_point_person_id": "1",
      "name": "Attend a fundraiser",
      "path_id": "1",
      "position": 1,
      "created_at": "2019-10-26T10:00:00-04:00",
      "updated_at": "2019-10-26T10:00:00-04:00"
    }
  },
  "included": [
    {
      "id": "1"
    }
  ]
}

Changes

  • d5c88ca497acRevision changes
    • breaking

      added subschema #2 to the request body allOf list

    • breaking

      the request's body type changed from object to no type

    • 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

    • warning

      removed the request property

    • info

      added the media type application/vnd.api+json to the request body

    • 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