{
  "opencollection": "1.0.0",
  "info": {
    "name": "Conversations",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "conversations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get a message",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.brevo.com/v3/conversations/messages/:id",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the message"
              }
            ]
          },
          "docs": "Retrieve a single message by its ID."
        },
        {
          "info": {
            "name": "Update a message sent by an agent",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.brevo.com/v3/conversations/messages/:id",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the message"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update the text of a message sent by an agent. Only messages of type `agent` can be edited. The `text` and `html` fields of the message will be updated."
        },
        {
          "info": {
            "name": "Delete a message sent by an agent",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.brevo.com/v3/conversations/messages/:id",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the message"
              }
            ]
          },
          "docs": "Delete a message sent by an agent. Only messages of type `agent` can be deleted."
        },
        {
          "info": {
            "name": "Send a message as an agent",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.brevo.com/v3/conversations/messages",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Send a message as an agent to an existing visitor's conversation. You must provide either `agentId` alone, or all three of `agentEmail` + `agentName` + `receivedFrom` to identify the agent."
        },
        {
          "info": {
            "name": "Get an automated message",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.brevo.com/v3/conversations/pushedMessages/:id",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the message sent previously"
              }
            ]
          },
          "docs": "Retrieve a single automated (pushed) message by its ID."
        },
        {
          "info": {
            "name": "Update an automated message",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.brevo.com/v3/conversations/pushedMessages/:id",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the message"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update the text of an automated (pushed) message. The `text` and `html` fields of the message will be updated."
        },
        {
          "info": {
            "name": "Delete an automated message",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.brevo.com/v3/conversations/pushedMessages/:id",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the message"
              }
            ]
          },
          "docs": "Delete an automated (pushed) message by its ID."
        },
        {
          "info": {
            "name": "Send an automated message to a visitor",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.brevo.com/v3/conversations/pushedMessages",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Send an automated (pushed) message to a visitor on behalf of an agent. Example use cases: order status updates, announcing new features in your web app, etc."
        },
        {
          "info": {
            "name": "Sets agent's status to online for 2-3 minutes",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.brevo.com/v3/conversations/agentOnlinePing",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Sets the agent's status to online for 2-3 minutes. We recommend pinging this endpoint every minute for as long as the agent has to be considered online. You must provide either `agentId` alone, or all three of `agentEmail` + `agentName` + `receivedFrom`."
        },
        {
          "info": {
            "name": "Set visitor group assignment",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.brevo.com/v3/conversations/visitorGroup",
            "headers": [
              {
                "name": "api-key",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Assigns a visitor to a specific agent group or removes them from their current group."
        }
      ]
    }
  ],
  "bundled": true
}