{
  "opencollection": "1.0.0",
  "info": {
    "name": "Spotio 2.0 Communication Templates API",
    "version": "v1"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "CommunicationTemplates",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get communication templates",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.spotio2.com/api/communication/templates",
            "params": [
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "The type of the communication template"
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "The status of the communication template"
              },
              {
                "name": "q",
                "value": "",
                "type": "query",
                "description": "Search query for filtering templates."
              },
              {
                "name": "scrollId",
                "value": "",
                "type": "query",
                "description": "Cursor for pagination (next page)"
              },
              {
                "name": "longSnippet",
                "value": "",
                "type": "query",
                "description": "If true, return 465 characters."
              },
              {
                "name": "dataObjectTypeId",
                "value": "",
                "type": "query",
                "description": "Filter templates by data object type ID."
              },
              {
                "name": "global",
                "value": "",
                "type": "query",
                "description": "If true, will return templates without assigned dataObjectType."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Returns a list of communication templates."
        },
        {
          "info": {
            "name": "Create a new communication templates",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.spotio2.com/api/communication/templates",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "A template can include user / dataObject variables and attachments."
        },
        {
          "info": {
            "name": "Get a communication template by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.spotio2.com/api/communication/templates/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Retrieves a communication template by its unique ID."
        },
        {
          "info": {
            "name": "Patch the communication template if user have a permission",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.spotio2.com/api/communication/templates/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Update template details."
        },
        {
          "info": {
            "name": "Delete the communication template",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.spotio2.com/api/communication/templates/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Delete the communication template"
        },
        {
          "info": {
            "name": " Retrieves a list of communication templates with basic details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.spotio2.com/api/communication/templates/simple",
            "params": [
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "The type of the communication template"
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "The status of the communication template"
              },
              {
                "name": "q",
                "value": "",
                "type": "query",
                "description": "The search query string"
              },
              {
                "name": "scrollId",
                "value": "",
                "type": "query",
                "description": "Cursor for pagination (next page)"
              },
              {
                "name": "dataObjectTypeId",
                "value": "",
                "type": "query",
                "description": "The ID of the data object type from workflow settings"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": " Retrieves a list of communication templates with basic details"
        },
        {
          "info": {
            "name": "Get communication template with basic details by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.spotio2.com/api/communication/templates/simple/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the communication template."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Returns a communication template with the specified ID."
        },
        {
          "info": {
            "name": "Get available variables for dataObjectType ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.spotio2.com/api/communication/templates/variables",
            "params": [
              {
                "name": "dataObjectTypeId",
                "value": "",
                "type": "query",
                "description": "List of variables which a user can use to create a new template for specific dataObject"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Get available variables for dataObjectType ID"
        },
        {
          "info": {
            "name": "Get all available variables",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.spotio2.com/api/communication/templates/variables/all",
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "List of variables which a user can use to create a new template"
        },
        {
          "info": {
            "name": "Get all available templates for dataObject Type ID)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.spotio2.com/api/communication/templates/all",
            "params": [
              {
                "name": "dataObjectTypeId",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "When DataObjectTypeId is empty return global templates"
        },
        {
          "info": {
            "name": "Get simple autoplays for communication template",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.spotio2.com/api/communication/templates/:id/autoplays",
            "params": [
              {
                "name": "sortBy",
                "value": "",
                "type": "query"
              },
              {
                "name": "scrollId",
                "value": "",
                "type": "query"
              },
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Get simple autoplays for communication template"
        }
      ]
    }
  ],
  "bundled": true
}