{
  "opencollection": "1.0.0",
  "info": {
    "name": "Cordial message content includes API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "message content includes",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get a single include",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.cordial.io/v1/includes/:key",
            "params": [
              {
                "name": "key",
                "value": "",
                "type": "path",
                "description": "Include Key"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Fields (can be many, separate by comma)"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Get a single include"
        },
        {
          "info": {
            "name": "Update a single include",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.cordial.io/v1/includes/:key",
            "params": [
              {
                "name": "key",
                "value": "",
                "type": "path",
                "description": "Include Key"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Update a single include"
        },
        {
          "info": {
            "name": "Delete an include",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.cordial.io/v1/includes/:key",
            "params": [
              {
                "name": "key",
                "value": "",
                "type": "path",
                "description": "Include Key"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Delete an include"
        },
        {
          "info": {
            "name": "Get includes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.cordial.io/v1/includes",
            "params": [
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Fields (can be many, separate by comma)"
              },
              {
                "name": "key",
                "value": "",
                "type": "query",
                "description": "Include Key"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Number of page"
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "Count include on page"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Get includes"
        },
        {
          "info": {
            "name": "Add a new include",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.cordial.io/v1/includes",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Add a new include"
        },
        {
          "info": {
            "name": "Get a single include",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.cordial.io/v2/includes/:key",
            "params": [
              {
                "name": "key",
                "value": "",
                "type": "path",
                "description": "Content include key value."
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Fields to retrieve (can be many, comma-separated)."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Retrieves the specified message content include from the HTML content library. The include is defined by its unique `key` value. For example, /includes/footer would return data for the content include with the key value of <b>footer</b>."
        },
        {
          "info": {
            "name": "Update a single include",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.cordial.io/v2/includes/:key",
            "params": [
              {
                "name": "key",
                "value": "",
                "type": "path",
                "description": "Content include key value."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Updates message content include name, description, and content fields. The include is defined by its unique `key` value. For example, /includes/footer would update the content include with the key value of <b>footer</b>."
        },
        {
          "info": {
            "name": "Delete an include",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.cordial.io/v2/includes/:key",
            "params": [
              {
                "name": "key",
                "value": "",
                "type": "path",
                "description": "Content include key value."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Deletes a content include from the HTML content library. The include is defined by its unique `key` value. For example, /includes/footer would delete the content include with the key value of <b>footer</b>."
        },
        {
          "info": {
            "name": "Get content includes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.cordial.io/v2/includes",
            "params": [
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Fields to retrieve (can be many, comma-separated)."
              },
              {
                "name": "key",
                "value": "",
                "type": "query",
                "description": "Content include key value."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Specific page number to be returned."
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "Number of records per page."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Retrieves message content includes from the HTML content library. Using query string parameters, it is possible to filter the response by content \"key\" to retrieve information for a single content include, as well as retrieve only the specified fields including name, createdAt, lastUpdate, and content."
        },
        {
          "info": {
            "name": "Add a content include",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.cordial.io/v2/includes",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Adds a new message content include to the HTML content library using the appropriate JSON body. Posting more than once for the same include key will generate an error."
        }
      ]
    }
  ],
  "bundled": true
}