{
  "opencollection": "1.0.0",
  "info": {
    "name": "Cordial account lists API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "account lists",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get a single list",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.cordial.io/v1/accountlists/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "List id"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Get a single list"
        },
        {
          "info": {
            "name": "Update List",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.cordial.io/v1/accountlists/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "List id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Update List"
        },
        {
          "info": {
            "name": "Delete an existing list",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.cordial.io/v1/accountlists/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Key for list"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Delete an existing list"
        },
        {
          "info": {
            "name": "Clear a list",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.cordial.io/v1/accountlists/:id/clear",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "List id"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Clear a list"
        },
        {
          "info": {
            "name": "Get lists",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.cordial.io/v1/accountlists",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Name given to the list"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Get lists"
        },
        {
          "info": {
            "name": "Add a new list",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.cordial.io/v1/accountlists",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Add a new list"
        },
        {
          "info": {
            "name": "Get a single list",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.cordial.io/v2/accountlists/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "List id value."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Retrieves the specified list. The list is defined by its unique `id` value. For example, /accountlists/128 would return the response data for the list with the id value of <b>128</b>."
        },
        {
          "info": {
            "name": "Update a list",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.cordial.io/v2/accountlists/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "List id value."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Updates the list name to a new value and enables or disables date tracking. Enabling list tracking will automatically track the date each contact was added to the list."
        },
        {
          "info": {
            "name": "Delete an existing list",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.cordial.io/v2/accountlists/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "List id value."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Deletes an existing list. The list is defined by its unique `id` value. For example, /accountlists/128 would delete the list with the id value of <b>128</b>."
        },
        {
          "info": {
            "name": "Get a single list with count of assigned contacts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.cordial.io/v2/accountlists/:id/count",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "List id value."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Retrieves the specified list. The list is defined by its unique `id` value. For example, /accountlists/128/count would return the response data for the list with the id value of <b>128</b> and count of contacts assigned to this list."
        },
        {
          "info": {
            "name": "Clear a list",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.cordial.io/v2/accountlists/:id/clear",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "List id value."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Removes all contact list associations for the given list `id` while retaining the list itself in the Cordial database. **Note:** when a list is cleared, no contacts are deleted from the system."
        },
        {
          "info": {
            "name": "Get lists",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.cordial.io/v2/accountlists",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "List name value."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Retrieves all lists from the Cordial database. It is possible to filter the response data for a specific list using the list `name` query string parameter."
        },
        {
          "info": {
            "name": "Add a list",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.cordial.io/v2/accountlists",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Creates a new list using the appropriate JSON body. Posting more than once for the same list name will generate an error.\n\nThe accountlists collection contains the names of lists used to define segments of your audience. For example, you may have lists for Weekly Specials, Daily Deals, and Fashion Newsletter. Each represents subscriber selections on information and promotions they requested to receive. You can also use accountlists to represent groups or segments you determine to be important su"
        }
      ]
    }
  ],
  "bundled": true
}