NAnationbuilder
Lists

Remove signups

Changed on

Remove Signup IDs from a list via an asynchronous process. Returns the token of an asynchronous process that can be queried using another endpoint. Accepts up to 10,000 signup IDs in a single payload.

patch/api/v2/lists/{id}/remove_signups

Request

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

Request body

Example request

{
  "data": {
    "id": "1",
    "type": "lists",
    "signup_ids": [
      "1",
      "2"
    ]
  }
}

Response

A token for tracking the asynchronous remove-signups process.

tokenstring

Example response

{
  "token": "1234"
}

Changes

  • d5c88ca497acRevision changes
    • breaking

      the request property const value lists was added

    • info

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

    • 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

      the response property became required for the status

    • info

      the response property became required for the status