{
  "opencollection": "1.0.0",
  "info": {
    "name": "Benchmark Email RESTful API v3.0 ABTest Creation Signup Form API",
    "version": "3.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "AuthToken",
      "value": "{{AuthToken}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Signup Form",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Gets a list of Signup Forms",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://clientapi.benchmarkemail.com/SignupForm",
            "params": [
              {
                "name": "PageNumber",
                "value": "",
                "type": "query"
              },
              {
                "name": "PageSize",
                "value": "",
                "type": "query"
              },
              {
                "name": "Filter",
                "value": "",
                "type": "query"
              },
              {
                "name": "FilterField",
                "value": "",
                "type": "query"
              },
              {
                "name": "OrderBy",
                "value": "",
                "type": "query"
              },
              {
                "name": "SortOrder",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "<h4>Gets a list of signup forms in the user's account</h4>\n<b>Query string parameters : </b>\n<table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Required</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>PageNumber</td>\n<td>optional</td>\n<td>int</td>\n<td>Page Number</td>\n</tr>\n<tr>\n<td>PageSize</td>\n<td>optional</td>\n<td>int</td>\n<td>Number of records to show per page</td>\n</tr>\n<tr>\n<td>Filter</td>\n<td>optional</td>\n<td>string</td>\n<td>Filter text</td>\n</tr>\n<tr>\n<td>FilterField</"
        },
        {
          "info": {
            "name": "Creating a Signup Form",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://clientapi.benchmarkemail.com/SignupForm/",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "<h4>Creates a new signup form </h4>\r\n\r\n<h4>Body Parameters (to be encoded as a JSON string)</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th>\r\n<th>Required</th>\r\n<th>Description</th>\r\n</tr>\r\n</thead>\r\n<tbody>\r\n<tr>\r\n<td>Name</td>\r\n<td>optional</td>\r\n<td>Name of the signup form</td>\r\n</tr>\r\n<tr>\r\n<td>Lists</td>\r\n<td>optional</td>\r\n<td>List details as ID and Name\r\n[{\"ID\":\"<code>IDOfTheList</code>\", \"Name\":\"<code>NameOfTheList</code>\"},{\"ID\":\"<code>IDOfTheList</code>\", \"Name\":\"<code>NameOfTheList</code>\"}"
        },
        {
          "info": {
            "name": "Get templates for Signup Form (Classic Only)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://clientapi.benchmarkemail.com/SignupForm/Template",
            "params": [
              {
                "name": "Language",
                "value": "",
                "type": "query"
              },
              {
                "name": "Filter",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "<h4>Gets templates for signup form</h4>\r\n<b>Query string parameters : </b>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Parameter</th>\r\n<th>Required</th>\r\n<th>Type</th>\r\n<th>Description</th>\r\n</tr>\r\n</thead>\r\n<tbody>\r\n<tr>\r\n<td>Language</td>\r\n<td>optional</td>\r\n<td>string</td>\r\n<td>Language</td>\r\n</tr>\r\n<tr>\r\n<td>Filter</td>\r\n<td>optional</td>\r\n<td>int</td>\r\n<td>Template Category ID</td>\r\n</tr>\r\n</tbody>\r\n</table>\r\n<b>Response Body parameters : </b>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Parameter</th>\r\n<th>Type</th>\r\n<t"
        },
        {
          "info": {
            "name": "Copy an existing Signup Form",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://clientapi.benchmarkemail.com/SignupForm/:ID/Copy",
            "params": [
              {
                "name": "ID",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "<h4>Copies an existing signup form</h4>\r\n<b>Query String Parameters : </b> None <br>\r\n<b>Request Body Parameters:</b>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Parameter</th>\r\n<th>Required</th>\r\n<th>Type</th>\r\n<th>Description</th>\r\n</tr>\r\n</thead>\r\n<tbody>\r\n<tr>\r\n<td>ID</td>\r\n<td>required</td>\r\n<td>string</td>\r\n<td>ID of the signup Form</td>\r\n</tr>\r\n<tr>\r\n<td>Name</td>\r\n<td>required</td>\r\n<td>string</td>\r\n<td>Name of the new signup form</td>\r\n</tr>\r\n</tbody>\r\n</table>\r\n<b>Response Body Parameters:</b>\r\n<tabl"
        },
        {
          "info": {
            "name": "Get a details of Signup Form",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://clientapi.benchmarkemail.com/SignupForm/:ID",
            "params": [
              {
                "name": "ID",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "<h4>Get a details of Signup Form</h4>\n<b>Query string parameters:</b>None<br>\n<b>Request Body parameters:</b>\n<table>\n  <thead>\n    <tr>\n      <th>Parameter</th>\n      <th>Required</th>\n      <th>Type</th>\n      <th>Description</th>\n    </tr>\n  </thead>\n  <tbody>\n    <tr>\n      <td>ID</td>\n      <td>Required</td>\n      <td>string</td>\n      <td>Signup Form ID</td>\n    </tr>\n  </tbody>\n</table>\n\n<b>Response Body parameters:</b>\n<table>\n  <thead>\n    <tr>\n      <th>Parameter</th>\n      <th>Type</t"
        },
        {
          "info": {
            "name": "Update the Signup Form",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://clientapi.benchmarkemail.com/SignupForm/:ID",
            "params": [
              {
                "name": "ID",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "<h4>Update the signup Form </h4>\n\n<b>Query String Parameters:</b> None\n\n<b>Request Body Parameters:</b>\n<table>\n  <thead>\n    <tr>\n      <th>Key</th>\n      <th>Required</th>\n      <th>Type</th>\n      <th>Description</th>\n    </tr>\n  </thead>\n  <tbody>\n    <tr>\n      <td>ID</td>\n      <td>Required</td>\n      <td>string</td>\n      <td>Signup Form ID</td>\n    </tr>\n    <tr>\n      <td>Detail</td>\n      <td>Required</td>\n      <td><a href=\"http://www.benchmarkemail.com/models.htm#SignupFormSignupForm"
        },
        {
          "info": {
            "name": "Delete an existing Signup Form",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://clientapi.benchmarkemail.com/SignupForm/:ID",
            "params": [
              {
                "name": "ID",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "<h4>Deletes an existing signup form</h4>\r\n<b>Query string Parameters : </b> None <br>\r\n<b>Request Body Parameters : </b>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Parameter</th>\r\n<th>Required</th>\r\n<th>type</th>\r\n<th>Description</th>\r\n</tr>\r\n</thead>\r\n<tbody>\r\n<tr>\r\n<td>{ID}</td>\r\n<td>required</td>\r\n<td>string</td>\r\n<td>ID of the signup Form</td>\r\n</tr>\r\n</tbody>\r\n</table>\r\n<b>Response Body Parameters : </b>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Parameter</th>\r\n<th>type</th>\r\n<th>Description</th>\r\n</tr>\r\n</thead>\r\n<t"
        },
        {
          "info": {
            "name": "Get the link of the Signup form",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://clientapi.benchmarkemail.com/SignupForm/:ID/Link",
            "params": [
              {
                "name": "ID",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "<h4>Get the link of the Signup form</h4>\n<b>Query String Parameters:</b>None<br>\n<b>Request Body parameters:</b>\n<table>\n  <thead>\n    <tr>\n      <th>Parameter</th>\n      <th>Required</th>\n      <th>Type</th>\n      <th>Description</th>\n    </tr>\n  </thead>\n  <tbody>\n    <tr>\n      <td>ID</td>\n      <td>Required</td>\n      <td>string</td>\n      <td>Signup Form ID</td>\n    </tr>\n  </tbody>\n</table>\n<b>Response Body parameters:</b>\n<table>\n  <thead>\n    <tr>\n      <th>Parameter</th>\n      <th>Type<"
        },
        {
          "info": {
            "name": "Get the code for Preview for the Signup Form",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://clientapi.benchmarkemail.com/SignupForm/:ID/Code/Preview",
            "params": [
              {
                "name": "ID",
                "value": "",
                "type": "path"
              },
              {
                "name": "Language",
                "value": "",
                "type": "query"
              },
              {
                "name": "Style",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "<h4>Get the code for Preview for the Signup Form</h4>\n<b>Query string parameters:</b>\n<table>\n  <thead>\n    <tr>\n      <th>Key</th>\n      <th>Required</th>\n      <th>Description</th>\n    </tr>\n  </thead>\n  <tbody>\n    <tr>\n      <td>ID</td>\n      <td>Required</td>\n      <td>Signup Form ID</td>\n    </tr>\n  </tbody>\n</table>\n\n<b>Request Body Parameters :</b>\n<table>\n  <thead>\n    <tr>\n      <th>Parameter</th>\n      <th>Required</th>\n      <th>Type</th>\n      <th>Description</th>\n    </tr>\n  </thea"
        },
        {
          "info": {
            "name": "Get the code for the Signup Form button",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://clientapi.benchmarkemail.com/SignupForm/:ID/Code/Button",
            "params": [
              {
                "name": "ID",
                "value": "",
                "type": "path"
              },
              {
                "name": "Language",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "<h4>Get the code for the signup form button</h4>\n<b>Query string parameters:</b>\n<table>\n  <thead>\n    <tr>\n      <th>Parameter</th>\n      <th>Required</th>\n      <th>Type</th>\n      <th>Description</th>\n    </tr>\n  </thead>\n  <tbody>\n    <tr>\n      <td>ID</td>\n      <td>Required</td>\n      <td>string</td>\n      <td>Signup Form ID</td>\n    </tr>\n  </tbody>\n</table>\n\n<b>Request Body Parameters :</b>\n<table>\n  <thead>\n    <tr>\n      <th>Parameter</th>\n      <th>Required</th>\n      <th>Type</th>\n  "
        },
        {
          "info": {
            "name": "Get the contact fields of the Signup Form",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://clientapi.benchmarkemail.com/SignupForm/:ID/ContactFields",
            "params": [
              {
                "name": "ID",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "<h4>Get the contact fields of the signup Form</h4>\n<b>Query string parameters :</b>\n<table>\n  <thead>\n    <tr>\n      <th>Parameter</th>\n      <th>Required</th>\n      <th>Type</th>\n      <th>Description</th>\n    </tr>\n  </thead>\n  <tbody>\n    <tr>\n      <td>ID</td>\n      <td>Required</td>\n      <td>string</td>\n      <td>Signup Form ID</td>\n    </tr>\n  </tbody>\n</table>\n\n<b>Request Body parameters:</b>\nNone\n\n<b>Response body parameters :</b>\n<table>\n  <thead>\n    <tr>\n      <th>Parameter</th>\n    "
        },
        {
          "info": {
            "name": "Sending a test email for signup",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://clientapi.benchmarkemail.com/SignupForm/:ID/Test",
            "params": [
              {
                "name": "ID",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "<h4>Sending a test email for signup</h4>\n<b>Query string parameters :</b> None <br>\n\n<b>Request Body parameters:</b>\n<table>\n  <thead>\n    <tr>\n      <th>Key</th>\n      <th>Required</th>\n      <th>Description</th>\n    </tr>\n  </thead>\n  <tbody>\n    <tr>\n      <td>ID</td>\n      <td>Required</td>\n      <td>Signup Form ID</td>\n    </tr>\n    <tr>\n      <td>FromEmail</td>\n      <td>Required</td>\n      <td>From Email  Address</td>\n    </tr>\n    <tr>\n      <td>FromName</td>\n      <td>Required</td>\n    "
        },
        {
          "info": {
            "name": "Get signup form list",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://clientapi.benchmarkemail.com/Contact/:ListID/ListbuilderLists",
            "params": [
              {
                "name": "ListID",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "<h4>Get a list of contacts</h4>\r\n<h4>URL Parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Required</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>{{ListIDs}}</td><td>required</td><td>string</td><td>IDs of the lists</td></tr>\r\n</tbody>\r\n</table>\r\n\r\n<h4>Response body parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>Status</td><td>string</td><td>1 if successful, -1 if error</td></tr>\r\n<tr><td>Coun"
        },
        {
          "info": {
            "name": "Get signup form list",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://clientapi.benchmarkemail.com/Contact/ListbuilderList"
          },
          "docs": "<h4>Get signup form list</h4>\r\n\r\n<h4>Response body parameters</h4>\r\n<table>\r\n<thead>\r\n<tr>\r\n<th>Key</th><th>Type</th><th>Description</th></tr>\r\n</thead>\r\n<tbody>\r\n<tr><td>Status</td><td>string</td><td>1 if successful, -1 if error</td></tr>\r\n<tr><td>Count</td><td>int</td><td>Total number</td></tr>\r\n<tr><td>Data</td><td><a href=\"http://www.benchmarkemail.com/models.htm#ContactSignupFormRecord\">SignupFormRecord</a></td><td>Signup Form Data</td></tr>\r\n</tbody>\r\n</table>"
        }
      ]
    }
  ],
  "bundled": true
}