{
  "opencollection": "1.0.0",
  "info": {
    "name": "Whippy Public Campaigns Contacts API",
    "version": "1.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "X-WHIPPY-KEY",
      "value": "{{X-WHIPPY-KEY}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Contacts",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List contacts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.whippy.co/v1/contacts",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of results per page (default 50, max 500)."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Number of results to skip for pagination."
              }
            ]
          },
          "docs": "List contacts"
        },
        {
          "info": {
            "name": "Create a contact",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.whippy.co/v1/contacts",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a contact"
        },
        {
          "info": {
            "name": "Show a contact",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.whippy.co/v1/contacts/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Resource UUID."
              }
            ]
          },
          "docs": "Show a contact"
        },
        {
          "info": {
            "name": "Update a contact",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.whippy.co/v1/contacts/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Resource UUID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a contact"
        },
        {
          "info": {
            "name": "Delete a contact",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.whippy.co/v1/contacts/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Resource UUID."
              }
            ]
          },
          "docs": "Delete a contact"
        },
        {
          "info": {
            "name": "Search contacts",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.whippy.co/v1/contacts/search",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Search contacts"
        },
        {
          "info": {
            "name": "Upsert contacts",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.whippy.co/v1/contacts/upsert",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create or update contacts keyed on phone / email / external_id."
        },
        {
          "info": {
            "name": "List a contact's communication preferences",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.whippy.co/v1/contacts/:id/communication_preferences",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Resource UUID."
              }
            ]
          },
          "docs": "List a contact's communication preferences"
        },
        {
          "info": {
            "name": "Opt a contact into a channel",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.whippy.co/v1/contacts/:id/communication_preferences/opt_in",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Resource UUID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Opt a contact into a channel"
        },
        {
          "info": {
            "name": "Opt a contact out of a channel",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.whippy.co/v1/contacts/:id/communication_preferences/opt_out",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Resource UUID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Opt a contact out of a channel"
        }
      ]
    }
  ],
  "bundled": true
}