{
  "opencollection": "1.0.0",
  "info": {
    "name": "Optimizely Campaign REST API",
    "version": "1.0"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Recipients",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List recipients",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.campaign.episerver.net/rest/:clientId/recipients/:recipientListId",
            "params": [
              {
                "name": "clientId",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the Optimizely Campaign client"
              },
              {
                "name": "recipientListId",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the recipient list"
              }
            ]
          },
          "docs": "Returns a list of recipients from the specified recipient list."
        },
        {
          "info": {
            "name": "Add a recipient",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.campaign.episerver.net/rest/:clientId/recipients/:recipientListId",
            "params": [
              {
                "name": "clientId",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the Optimizely Campaign client"
              },
              {
                "name": "recipientListId",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the recipient list"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Adds a new recipient to the specified recipient list."
        },
        {
          "info": {
            "name": "Get a recipient",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.campaign.episerver.net/rest/:clientId/recipients/:recipientListId/:recipientId",
            "params": [
              {
                "name": "clientId",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the Optimizely Campaign client"
              },
              {
                "name": "recipientListId",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the recipient list"
              },
              {
                "name": "recipientId",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the recipient"
              }
            ]
          },
          "docs": "Retrieves the details of a specific recipient from a recipient list."
        },
        {
          "info": {
            "name": "Update a recipient",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.campaign.episerver.net/rest/:clientId/recipients/:recipientListId/:recipientId",
            "params": [
              {
                "name": "clientId",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the Optimizely Campaign client"
              },
              {
                "name": "recipientListId",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the recipient list"
              },
              {
                "name": "recipientId",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the recipient"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the specified recipient with the provided fields."
        },
        {
          "info": {
            "name": "Delete a recipient",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.campaign.episerver.net/rest/:clientId/recipients/:recipientListId/:recipientId",
            "params": [
              {
                "name": "clientId",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the Optimizely Campaign client"
              },
              {
                "name": "recipientListId",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the recipient list"
              },
              {
                "name": "recipientId",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the recipient"
              }
            ]
          },
          "docs": "Removes a recipient from the specified recipient list."
        }
      ]
    },
    {
      "info": {
        "name": "Smart Campaigns",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List smart campaigns",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.campaign.episerver.net/rest/:clientId/smartcampaigns",
            "params": [
              {
                "name": "clientId",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the Optimizely Campaign client"
              }
            ]
          },
          "docs": "Returns a list of smart campaigns for the specified client."
        },
        {
          "info": {
            "name": "Get a smart campaign",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.campaign.episerver.net/rest/:clientId/smartcampaigns/:campaignId",
            "params": [
              {
                "name": "clientId",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the Optimizely Campaign client"
              },
              {
                "name": "campaignId",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the campaign"
              }
            ]
          },
          "docs": "Retrieves the details of a specific smart campaign."
        },
        {
          "info": {
            "name": "Start a smart campaign",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.campaign.episerver.net/rest/:clientId/smartcampaigns/:campaignId/start",
            "params": [
              {
                "name": "clientId",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the Optimizely Campaign client"
              },
              {
                "name": "campaignId",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the campaign"
              }
            ]
          },
          "docs": "Starts the specified smart campaign, beginning the automated workflow execution."
        },
        {
          "info": {
            "name": "Pause a smart campaign",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.campaign.episerver.net/rest/:clientId/smartcampaigns/:campaignId/pause",
            "params": [
              {
                "name": "clientId",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the Optimizely Campaign client"
              },
              {
                "name": "campaignId",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the campaign"
              }
            ]
          },
          "docs": "Pauses the specified smart campaign."
        }
      ]
    },
    {
      "info": {
        "name": "Transactional Mail",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Send a transactional mail",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.campaign.episerver.net/rest/:clientId/transactionalmail",
            "params": [
              {
                "name": "clientId",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the Optimizely Campaign client"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Sends a transactional email to a specific recipient. Transactional mails are triggered by recipient actions or events such as order confirmations, password resets, or account notifications."
        }
      ]
    },
    {
      "info": {
        "name": "Mailing Lists",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List mailing lists",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.campaign.episerver.net/rest/:clientId/mailinglists",
            "params": [
              {
                "name": "clientId",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the Optimizely Campaign client"
              }
            ]
          },
          "docs": "Returns a list of mailing lists for the specified client."
        },
        {
          "info": {
            "name": "Get a mailing list",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.campaign.episerver.net/rest/:clientId/mailinglists/:mailingListId",
            "params": [
              {
                "name": "clientId",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the Optimizely Campaign client"
              },
              {
                "name": "mailingListId",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the mailing list"
              }
            ]
          },
          "docs": "Retrieves the details of a specific mailing list."
        }
      ]
    },
    {
      "info": {
        "name": "Unsubscribes",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List unsubscribes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.campaign.episerver.net/rest/:clientId/unsubscribes",
            "params": [
              {
                "name": "clientId",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the Optimizely Campaign client"
              }
            ]
          },
          "docs": "Returns a list of recipients who have unsubscribed from communications."
        },
        {
          "info": {
            "name": "Add an unsubscribe",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.campaign.episerver.net/rest/:clientId/unsubscribes",
            "params": [
              {
                "name": "clientId",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the Optimizely Campaign client"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Adds a recipient to the unsubscribe list."
        }
      ]
    },
    {
      "info": {
        "name": "Assets",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List assets",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.campaign.episerver.net/rest/:clientId/assets",
            "params": [
              {
                "name": "clientId",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the Optimizely Campaign client"
              }
            ]
          },
          "docs": "Returns a list of campaign assets such as images and media files."
        },
        {
          "info": {
            "name": "Upload an asset",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.campaign.episerver.net/rest/:clientId/assets",
            "params": [
              {
                "name": "clientId",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the Optimizely Campaign client"
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "file",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "name",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          },
          "docs": "Uploads a new asset for use in campaigns."
        }
      ]
    }
  ],
  "bundled": true
}