NAnationbuilder
Suggestion Boxes

Create a suggestion box

Changed on

Creates a SuggestionBox page from given data.

Required attributes:

  • site_id - ID of the site to create the page on
  • name - Display name for the page
  • status - Publication status ('published', 'draft', 'unlisted')

Optional attributes:

  • slug - URL-friendly identifier -- https://yoursite.com/slug (auto-generated from name if not provided)
  • content - Description/instructions for the page
  • tag_list - Comma-separated list of tags to be used for categorizing Suggestions
  • require_image - Whether suggestions must include images (default: false)
  • send_auto_responses - Enable automatic thank you emails when suggestions are submitted (boolean, default: true)
  • auto_response_broadcaster - Broadcaster ID for automatic thank you responses (integer, defaults to site broadcaster)
  • send_response_notifications - Enable automatic emails when community members respond to suggestions (boolean, default: true)
  • response_notification_broadcaster - Broadcaster ID for community response notifications (integer, defaults to site broadcaster)
  • send_official_response_notifications - Enable automatic email notifications when officials provide answers to suggestions (boolean, default: true)
  • official_response_notification_broadcaster - Broadcaster ID for official response notifications (integer, defaults to site broadcaster)
  • point_person_id - Signup ID of the Point Person assigned to manage Suggestions in this SuggestionBox
post/api/v2/suggestion_boxes

Request

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

Request body

Example request

{
  "data": {
    "type": "suggestion_boxes",
    "attributes": {
      "allow_image": true,
      "auto_response_broadcaster": "1",
      "content": "Share your ideas for improving our community",
      "external_id": "ext-123",
      "headline": "Community Ideas",
      "name": "Community Ideas",
      "official_response_notification_broadcaster": "1",
      "point_person_id": "1",
      "response_notification_broadcaster": "1",
      "send_auto_responses": true,
      "send_official_response_notifications": true,
      "send_response_notifications": true,
      "site_id": "123",
      "slug": "my-page-slug",
      "status": "published",
      "tag_list": "Good, Bad, Important, Easy, Impractical",
      "title": "Community Ideas - My Site"
    }
  }
}

Response

The newly created suggestion box.

metaobject

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

Example response

{
  "data": {
    "id": "1",
    "type": "suggestion_boxes",
    "attributes": {
      "allow_image": true,
      "auto_response_broadcaster": "1",
      "content": "Share your ideas for improving our community",
      "external_id": "ext-123",
      "headline": "Community Ideas",
      "name": "Community Ideas",
      "official_response_notification_broadcaster": "1",
      "point_person_id": "1",
      "response_notification_broadcaster": "1",
      "send_auto_responses": true,
      "send_official_response_notifications": true,
      "send_response_notifications": true,
      "site_id": "123",
      "slug": "my-page-slug",
      "status": "published",
      "tag_list": "Good, Bad, Important, Easy, Impractical",
      "title": "Community Ideas - My Site",
      "created_at": "2019-10-26T10:00:00-04:00",
      "page_id": "1",
      "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

    • warning

      removed the optional property from the response with the status

    • 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

      the response property became required for the status

    • info

      the response property became required for the status

  • 31995b0a1e61Revision changes
    • info

      endpoint added