{
"openapi": "3.0.0",
"info": {
"title": "Marketing API",
"description": " # Introduction\nWelcome to the E-goi Marketing API!\n
This API enables you to integrate, automate, and manage all the marketing functionalities offered by E-goi. With it, you can interact with contact lists, send email campaigns, SMS, push notifications, and much more.\n
Our API is designed to simplify integration in a straightforward, efficient, and secure way, meeting the needs of developers and businesses looking to optimize their digital marketing operations.\n
Explore the documentation to discover all the possibilities and start creating integrations that drive your marketing results.\n# Getting Started\n\nE-goi can be integrated with many environments and programming languages via our REST API.\nWe've created a developer focused portal to give your organization a clear and quick overview of how to integrate with E-goi.\nThe developer portal focuses on scenarios for integration and flow of events. We recommend familiarizing yourself with all of the content in the developer portal, before start using our rest API.\n\nThe E-goi APIv3 is served over HTTPS. To ensure data privacy, unencrypted HTTP is not supported.\n\nRequest data is passed to the API by POSTing JSON objects to the API endpoints with the appropriate parameters.\n\n BaseURL = api.egoiapp.com\n\n# RESTful Services\nThis API supports 5 HTTP methods:\n\n* GET:\nThe HTTP GET method is used to **read** (or retrieve) a representation of a resource.\n* POST:\nThe POST verb is most-often utilized to **create** new resources.\n* PATCH:\nPATCH is used for **modify** capabilities. The PATCH request only needs to contain the changes to the resource, not the complete resource\n* PUT:\nPUT is most-often utilized for **update** capabilities, PUT-ing to a known resource URI with the request body containing the newly-updated representation of the original resource.\n* DELETE:\nDELETE is pretty easy to understand. It is used to **delete** a resource identified by a URI.\n\n# Transport Layer Security (TLS)\nTransport Layer Security (TLS) is a widely used authentication and encryption protocol that establishes a secure communications channel for data-in-transit while ensuring that the client and server can validate one another.
\nOur API requires TLS 1.2 or TLS 1.3. We recommend TLS 1.3.
\nTLS 1.3 ciphers\n* TLS_AES_256_GCM_SHA384 (0x1302) ECDH x25519 (eq. 3072 bits RSA) FS\n* TLS_CHACHA20_POLY1305_SHA256 (0x1303) ECDH x25519 (eq. 3072 bits RSA) FS\n* TLS_AES_128_GCM_SHA256 (0x1301) ECDH x25519 (eq. 3072 bits RSA) FS\n\nTLS 1.2 ciphers\n* TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (0xc030) ECDH x25519 (eq. 3072 bits RSA) FS\n* TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 (0xc02f) ECDH x25519 (eq. 3072 bits RSA) FS\n* TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 (0x9f) DH 4096 bits FS\n* TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 (0x9e) DH 4096 bits FS\n\n# Rate Limits\nRate limits are used to control the amount of traffic that is allowed to flow between the client and the server.
\nThis is done to prevent abuse and ensure that the API is available to all users.
\nThe rate limits are applied to ensure the stability and security of our API and are based on the number of requests made in a given time period.
\nIf the rate limit is exceeded, the API will return a 429 status code and the request will be rejected.
\nEach API response includes headers providing real-time rate limit information:\n* **X-RateLimit-Limit**: The maximum number of requests that the consumer is permitted to make in a given time period.\n* **X-RateLimit-Remaining**: The number of requests remaining in the current rate limit window.\n* **X-RateLimit-Reset**: The remaining time in seconds until the rate limit window resets.\n\n# Account Limit\nThe account limit is a rate limit that is applied to the account as a whole.
\nThis limit is applied to all requests made by the account, regardless of the client making the request.
\nThe account limit is applied to ensure that the account does not exceed the maximum number of requests allowed in a given time period.\nEach account has an overall usage limit per hour. If the account limit is exceeded, the API will return a 429 status code and the request will be rejected.
\nEach API response includes headers providing real-time rate limit information:\n* **X-Account-Limit**: The maximum number of requests that the account is permitted to make in a given time period.\n* **X-Account-Remaining**: The number of requests remaining in the current rate limit window.\n* **X-Account-Reset**: The remaining time in seconds until the rate limit window resets.\n\n\n# Authentication\n\nWe use a custom authentication method, you will need a apikey that you can find in your account settings. Below you will see a curl example to get your account information:\n #!/bin/bash\n curl -X GET 'https://api.egoiapp.com/my-account' \\\n -H 'accept: application/json' \\\n -H 'Apikey: '\n\nHere you can see a curl Post example with authentication:\n #!/bin/bash\n curl -X POST 'http://api.egoiapp.com/tags' \\\n -H 'accept: application/json' \\\n -H 'Apikey: ' \\\n -H 'Content-Type: application/json' \\\n -d '{`name`:`Your custom tag`,`color`:`#FFFFFF`}'\n\n# SDK\nGet started quickly with E-goi with our integration tools. Our SDK is a modern open source library that makes it easy to integrate your application with E-goi services.\n * Java\n * PHP\n * Python\n * Ruby\n * Javascript\n * C#\n\n# Stream Limits\nStream limits are security mesures we have to make sure our API have a fair use policy, for this reason, any request that creates or modifies data (**POST**, **PATCH** and **PUT**) is limited to a maximum of **20MB** of content length. If you arrive to this limit in one of your request, you'll receive a HTTP code **413 (Request Entity Too Large)** and the request will be ignored. To avoid this error in importation's requests, it's advised the request's division in batches that have each one less than 20MB.\n\n# Timeouts\nTimeouts set a maximum waiting time on a request's response. Our API, sets a default timeout for each request and when breached, you'll receive an HTTP **408 (Request Timeout)** error code. You should take into consideration that response times can vary widely based on the complexity of the request, amount of data being analyzed, and the load on the system and workspace at the time of the query. When dealing with such errors, you should first attempt to reduce the complexity and amount of data under analysis, and only then, if problems are still occurring ask for support.\n\nFor all these reasons, the default timeout for each request is **10 Seconds** and any request that creates or modifies data (**POST**, **PATCH** and **PUT**) will have a timeout of **60 Seconds**. Specific timeouts may exist for specific requests, these can be found in the request's documentation.\n\n# Callbacks\nA callback is an asynchronous API request that originates from the API server and is sent to the client in response to a previous request sent by that client.\n\nThe API will make a **POST** request to the address defined in the URL with the information regarding the event of interest and share data related to that event.\n\n[Go to callbacks documentation]\n\n***Note:*** Only http or https protocols are supported in the Url parameter.\n\n",
"version": "V3"
},
"servers": [
{
"url": "https://api.egoiapp.com",
"description": "Egoi Public API Server"
}
],
"paths": {
"/automations/{automation_id}/actions": {
"get": {
"tags": [
"Automations"
],
"summary": "Get all actions from given automation",
"description": "Returns all actions",
"operationId": "getAllActions",
"parameters": [
{
"name": "automation_id",
"in": "query",
"description": "Reference attribute to automation id",
"required": false,
"allowEmptyValue": false,
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"in": "query",
"description": "Element offset (starting at zero for the first element)",
"required": false,
"allowEmptyValue": false,
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "limit",
"in": "query",
"description": "Number of items to return",
"required": false,
"allowEmptyValue": false,
"schema": {
"type": "integer",
"default": 10,
"maximum": 1000,
"minimum": 1
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "AutomationActionsCollection",
"description": "Collection of automation actions",
"properties": {
"total_items": {
"description": "Returned actions count",
"type": "integer",
"minimum": 0,
"example": 1
},
"items": {
"description": "Returned actions",
"type": "array",
"items": {
"title": "AutomationActions",
"description": "Automation actions schema",
"type": "object",
"allOf": [
{
"properties": {
"action_id": {
"title": "ID",
"type": "integer",
"minimum": 1,
"readOnly": true,
"example": 1
},
"title": {
"description": "Action title",
"type": "string",
"example": "Example Action"
},
"action": {
"description": "Type od action",
"type": "string",
"example": "addTag"
},
"parent_id": {
"title": "ID",
"type": "integer",
"minimum": 1,
"readOnly": true,
"example": 1
},
"created_by": {
"title": "ID",
"type": "integer",
"minimum": 1,
"readOnly": true,
"example": 1
},
"created": {
"readOnly": true,
"allOf": [
{
"title": "date_time",
"description": "The date and time",
"type": "string",
"format": "date-time",
"example": "YYYY-MM-DD hh:mm:ss"
}
]
},
"updated": {
"readOnly": true,
"allOf": [
{
"title": "date_time",
"description": "The date and time",
"type": "string",
"format": "date-time",
"example": "YYYY-MM-DD hh:mm:ss"
}
]
}
},
"type": "object"
}
]
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"title": "Unauthorized",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Unauthorized"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 401
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The request has not been applied because it lacks valid authentication credentials for the target resource"
}
},
"type": "object"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"title": "Forbidden",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Forbidden"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 403
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The server understood the request but refuses to authorize it"
}
},
"type": "object"
}
}
}
},
"408": {
"description": "Request Timeout",
"content": {
"application/json": {
"schema": {
"title": "Request Timeout",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Request Timeout"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 408
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The server did not receive a complete request from the client within the server’s allotted timeout period"
}
},
"type": "object"
}
}
}
},
"422": {
"description": "Unprocessable Entity",
"content": {
"application/json": {
"schema": {
"title": "Unprocessable Entity",
"properties": {
"errors": {
"description": "Information about the input validation",
"type": "object"
},
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Unprocessable Entity"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 422
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The server understands the content type of the request entity, and the syntax of the request entity is correct but was unable to process the contained instructions"
}
},
"type": "object"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"title": "Too Many Requests",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Too Many Requests"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 429
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The user has sent too many requests in a given amount of time"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"title": "Internal Server Error",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Internal Server Error"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 500
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The server encountered an unexpected condition that prevented it from fulfilling the request"
}
},
"type": "object"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"title": "Service Unavailable",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Service Unavailable"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 503
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, whichwill likely be alleviated after some delay"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"Apikey": []
}
],
"x-code-samples": [
{
"lang": "cURL",
"source": "curl --location --max-time 30 --request GET 'api.egoiapp.com/automations/:automation_id/actions?automation_id=&offset=&limit=10' \\\n--header 'Apikey: '"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"api.egoiapp.com/automations/:automation_id/actions?automation_id=&offset=&limit=10\");\nclient.Timeout = 30;\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Apikey\", \"\");\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient().newBuilder()\n .setConnectTimeout(30, TimeUnit.MILLISECONDS)\n .build();\nRequest request = new Request.Builder()\n .url(\"api.egoiapp.com/automations/:automation_id/actions?automation_id=&offset=&limit=10\")\n .method(\"GET\", null)\n .addHeader(\"Apikey\", \"\")\n .build();\nResponse response = client.newCall(request).execute();"
},
{
"lang": "JavaScript",
"source": "\nvar xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function() {\n if(this.readyState === 4) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"api.egoiapp.com/automations/:automation_id/actions?automation_id=&offset=&limit=10\");\nxhr.timeout = 30;\nxhr.addEventListener(\"ontimeout\", function(e) {\n console.log(e);\n});\nxhr.setRequestHeader(\"Apikey\", \"\");\n\nxhr.send();"
},
{
"lang": "PHP",
"source": " \"api.egoiapp.com/automations/:automation_id/actions?automation_id=&offset=&limit=10\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => array(\n \"Apikey: \"\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n"
},
{
"lang": "Python",
"source": "import http.client\nimport mimetypes\nconn = http.client.HTTPSConnection(\"api.egoiapp.com\", timeout = 30)\npayload = ''\nheaders = {\n 'Apikey': ''\n}\nconn.request(\"GET\", \"/automations/:automation_id/actions?automation_id=&offset=&limit=10\", payload, headers)\nres = conn.getresponse()\ndata = res.read()\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Ruby",
"source": "require \"uri\"\nrequire \"net/http\"\n\nurl = URI(\"api.egoiapp.com/automations/:automation_id/actions?automation_id=&offset=&limit=10\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nhttp.read_timeout = 1\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Apikey\"] = \"\"\n\nresponse = http.request(request)\nputs response.read_body\n"
}
]
}
},
"/automations": {
"get": {
"tags": [
"Automations"
],
"summary": "Get all automations",
"description": "Returns all automations",
"operationId": "getAllAutomations",
"parameters": [
{
"name": "automation_id",
"in": "query",
"description": "Reference attribute to automation id",
"required": false,
"allowEmptyValue": false,
"schema": {
"type": "integer"
}
},
{
"name": "title",
"in": "query",
"description": "Reference attribute to title",
"required": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
}
},
{
"name": "created_by",
"in": "query",
"description": "Reference attribute to created by",
"required": false,
"allowEmptyValue": false,
"schema": {
"type": "integer"
}
},
{
"name": "list_id",
"in": "query",
"description": "ID of the list that owns the automation",
"required": false,
"allowEmptyValue": false,
"schema": {
"title": "ID",
"type": "integer",
"minimum": 1,
"example": 1
}
},
{
"name": "status",
"in": "query",
"description": "Automation status",
"required": false,
"allowEmptyValue": false,
"schema": {
"type": "string",
"enum": [
"active",
"inactive"
]
}
},
{
"name": "offset",
"in": "query",
"description": "Element offset (starting at zero for the first element)",
"required": false,
"allowEmptyValue": false,
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "limit",
"in": "query",
"description": "Number of items to return",
"required": false,
"allowEmptyValue": false,
"schema": {
"type": "integer",
"default": 10,
"maximum": 1000,
"minimum": 1
}
},
{
"name": "order",
"in": "query",
"description": "Type of order",
"required": false,
"allowEmptyValue": false,
"schema": {
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
]
}
},
{
"name": "order_by",
"in": "query",
"description": "Reference attribute to order automations",
"required": false,
"allowEmptyValue": false,
"schema": {
"type": "string",
"default": "automation_id",
"enum": [
"automation_id",
"title",
"list_id",
"created_by"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "AutomationCollection",
"description": "Collection of automations",
"properties": {
"total_items": {
"description": "Returned automations",
"type": "integer",
"minimum": 0,
"example": 1
},
"items": {
"description": "Returned automations",
"type": "array",
"items": {
"title": "Automation",
"description": "Automation schema",
"type": "object",
"allOf": [
{
"properties": {
"automation_id": {
"title": "ID",
"type": "integer",
"minimum": 1,
"readOnly": true,
"example": 1
},
"title": {
"description": "Automation title",
"type": "string",
"example": "Example Automation"
},
"list_id": {
"title": "ID",
"type": "integer",
"minimum": 1,
"example": 1
},
"status": {
"description": "Automation status",
"type": "string",
"enum": [
"active",
"inactive"
]
},
"created_by": {
"title": "ID",
"type": "integer",
"minimum": 1,
"readOnly": true,
"example": 1
},
"allow_multiple_contacts": {
"description": "True if the automation allows multiple contacts, false otherwise",
"type": "boolean",
"default": true
},
"contact_limit": {
"description": "Contact limit for the automation. Contact limit value (value '0' is returned if contact\n limit is not enabled)",
"type": "integer",
"minimum": 0,
"example": 10
},
"created": {
"readOnly": true,
"allOf": [
{
"title": "date",
"description": "The date",
"type": "string",
"format": "date",
"example": "YYYY-MM-DD"
}
]
},
"updated": {
"readOnly": true,
"allOf": [
{
"title": "date",
"description": "The date",
"type": "string",
"format": "date",
"example": "YYYY-MM-DD"
}
]
}
},
"type": "object"
}
]
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"title": "Unauthorized",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Unauthorized"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 401
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The request has not been applied because it lacks valid authentication credentials for the target resource"
}
},
"type": "object"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"title": "Forbidden",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Forbidden"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 403
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The server understood the request but refuses to authorize it"
}
},
"type": "object"
}
}
}
},
"408": {
"description": "Request Timeout",
"content": {
"application/json": {
"schema": {
"title": "Request Timeout",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Request Timeout"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 408
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The server did not receive a complete request from the client within the server’s allotted timeout period"
}
},
"type": "object"
}
}
}
},
"422": {
"description": "Unprocessable Entity",
"content": {
"application/json": {
"schema": {
"title": "Unprocessable Entity",
"properties": {
"errors": {
"description": "Information about the input validation",
"type": "object"
},
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Unprocessable Entity"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 422
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The server understands the content type of the request entity, and the syntax of the request entity is correct but was unable to process the contained instructions"
}
},
"type": "object"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"title": "Too Many Requests",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Too Many Requests"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 429
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The user has sent too many requests in a given amount of time"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"title": "Internal Server Error",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Internal Server Error"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 500
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The server encountered an unexpected condition that prevented it from fulfilling the request"
}
},
"type": "object"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"title": "Service Unavailable",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Service Unavailable"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 503
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, whichwill likely be alleviated after some delay"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"Apikey": []
}
],
"x-code-samples": [
{
"lang": "cURL",
"source": "curl --location --max-time 30 --request GET 'api.egoiapp.com/automations?automation_id=&title=&created_by=&list_id=&status=&offset=&limit=10&order=desc&order_by=automation_id' \\\n--header 'Apikey: '"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"api.egoiapp.com/automations?automation_id=&title=&created_by=&list_id=&status=&offset=&limit=10&order=desc&order_by=automation_id\");\nclient.Timeout = 30;\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Apikey\", \"\");\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient().newBuilder()\n .setConnectTimeout(30, TimeUnit.MILLISECONDS)\n .build();\nRequest request = new Request.Builder()\n .url(\"api.egoiapp.com/automations?automation_id=&title=&created_by=&list_id=&status=&offset=&limit=10&order=desc&order_by=automation_id\")\n .method(\"GET\", null)\n .addHeader(\"Apikey\", \"\")\n .build();\nResponse response = client.newCall(request).execute();"
},
{
"lang": "JavaScript",
"source": "\nvar xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function() {\n if(this.readyState === 4) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"api.egoiapp.com/automations?automation_id=&title=&created_by=&list_id=&status=&offset=&limit=10&order=desc&order_by=automation_id\");\nxhr.timeout = 30;\nxhr.addEventListener(\"ontimeout\", function(e) {\n console.log(e);\n});\nxhr.setRequestHeader(\"Apikey\", \"\");\n\nxhr.send();"
},
{
"lang": "PHP",
"source": " \"api.egoiapp.com/automations?automation_id=&title=&created_by=&list_id=&status=&offset=&limit=10&order=desc&order_by=automation_id\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => array(\n \"Apikey: \"\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n"
},
{
"lang": "Python",
"source": "import http.client\nimport mimetypes\nconn = http.client.HTTPSConnection(\"api.egoiapp.com\", timeout = 30)\npayload = ''\nheaders = {\n 'Apikey': ''\n}\nconn.request(\"GET\", \"/automations?automation_id=&title=&created_by=&list_id=&status=&offset=&limit=10&order=desc&order_by=automation_id\", payload, headers)\nres = conn.getresponse()\ndata = res.read()\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Ruby",
"source": "require \"uri\"\nrequire \"net/http\"\n\nurl = URI(\"api.egoiapp.com/automations?automation_id=&title=&created_by=&list_id=&status=&offset=&limit=10&order=desc&order_by=automation_id\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nhttp.read_timeout = 1\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Apikey\"] = \"\"\n\nresponse = http.request(request)\nputs response.read_body\n"
}
]
}
},
"/automations/{automation_id}": {
"delete": {
"tags": [
"Automations"
],
"summary": "Remove automation",
"description": "Remove automation information given its ID",
"operationId": "deleteAutomation",
"parameters": [
{
"name": "automation_id",
"in": "path",
"description": "ID of the Automation",
"required": true,
"allowEmptyValue": false,
"schema": {
"title": "ID",
"type": "integer",
"minimum": 1,
"example": 1
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"title": "Unauthorized",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Unauthorized"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 401
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The request has not been applied because it lacks valid authentication credentials for the target resource"
}
},
"type": "object"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"title": "Forbidden",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Forbidden"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 403
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The server understood the request but refuses to authorize it"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"title": "Not Found",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"NotFound"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 404
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The origin server did not find a current representation for the target resource or is not willing to disclose that one exists"
}
},
"type": "object"
}
}
}
},
"408": {
"description": "Request Timeout",
"content": {
"application/json": {
"schema": {
"title": "Request Timeout",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Request Timeout"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 408
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The server did not receive a complete request from the client within the server’s allotted timeout period"
}
},
"type": "object"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"title": "Conflict",
"type": "object",
"allOf": [
{
"properties": {
"errors": {
"description": "Information about the conflict",
"type": "object"
}
},
"type": "object"
},
{
"title": "BaseConflict",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Conflict"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 409
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The request could not be completed due to a conflict with the current state of the target resource"
}
},
"type": "object"
}
]
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"title": "Too Many Requests",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Too Many Requests"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 429
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The user has sent too many requests in a given amount of time"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"title": "Internal Server Error",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Internal Server Error"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 500
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The server encountered an unexpected condition that prevented it from fulfilling the request"
}
},
"type": "object"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"title": "Service Unavailable",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Service Unavailable"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 503
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, whichwill likely be alleviated after some delay"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"Apikey": []
}
],
"x-code-samples": [
{
"lang": "cURL",
"source": "curl --location --max-time 30 --request DELETE 'api.egoiapp.com/automations/' \\\n--header 'Apikey: '"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"api.egoiapp.com/automations/\");\nclient.Timeout = 30;\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Apikey\", \"\");\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient().newBuilder()\n .setConnectTimeout(30, TimeUnit.MILLISECONDS)\n .build();\nMediaType mediaType = MediaType.parse(\"text/plain\");\nRequestBody body = RequestBody.create(mediaType, \"\");\nRequest request = new Request.Builder()\n .url(\"api.egoiapp.com/automations/\")\n .method(\"DELETE\", body)\n .addHeader(\"Apikey\", \"\")\n .build();\nResponse response = client.newCall(request).execute();"
},
{
"lang": "JavaScript",
"source": "\nvar xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function() {\n if(this.readyState === 4) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"api.egoiapp.com/automations/\");\nxhr.timeout = 30;\nxhr.addEventListener(\"ontimeout\", function(e) {\n console.log(e);\n});\nxhr.setRequestHeader(\"Apikey\", \"\");\n\nxhr.send();"
},
{
"lang": "PHP",
"source": " \"api.egoiapp.com/automations/\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"DELETE\",\n CURLOPT_HTTPHEADER => array(\n \"Apikey: \"\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n"
},
{
"lang": "Python",
"source": "import http.client\nimport mimetypes\nconn = http.client.HTTPSConnection(\"api.egoiapp.com\", timeout = 30)\npayload = ''\nheaders = {\n 'Apikey': ''\n}\nconn.request(\"DELETE\", \"/automations/\", payload, headers)\nres = conn.getresponse()\ndata = res.read()\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Ruby",
"source": "require \"uri\"\nrequire \"net/http\"\n\nurl = URI(\"api.egoiapp.com/automations/\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nhttp.read_timeout = 1\nrequest = Net::HTTP::Delete.new(url)\nrequest[\"Apikey\"] = \"\"\n\nresponse = http.request(request)\nputs response.read_body\n"
}
]
}
},
"/campaigns": {
"get": {
"tags": [
"Campaigns"
],
"summary": "Get all Campaigns",
"description": "Returns all campaigns",
"operationId": "getAllCampaigns",
"parameters": [
{
"name": "channel",
"in": "query",
"description": "Channel of the campaign",
"required": false,
"allowEmptyValue": false,
"schema": {
"type": "string",
"enum": [
"email",
"push",
"sms",
"smart_sms",
"voice",
"web_push"
]
}
},
{
"name": "campaign_hash",
"in": "query",
"description": "Hash of the campaign",
"required": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
}
},
{
"name": "list_id",
"in": "query",
"description": "ID of the list where the campaign belongs",
"required": false,
"allowEmptyValue": false,
"schema": {
"type": "integer"
}
},
{
"name": "status",
"in": "query",
"description": "Status of the campaign",
"required": false,
"allowEmptyValue": false,
"schema": {
"type": "string",
"enum": [
"draft",
"canceled",
"queued",
"paused",
"sending",
"sent"
]
}
},
{
"name": "internal_name",
"in": "query",
"description": "Internal name of the campaign",
"required": false,
"allowEmptyValue": false,
"schema": {
"type": "string"
}
},
{
"name": "created_by",
"in": "query",
"description": "ID of the user who created the campaign",
"required": false,
"allowEmptyValue": false,
"schema": {
"type": "integer"
}
},
{
"name": "group_id",
"in": "query",
"description": "ID of the group where the campaign belongs",
"required": false,
"allowEmptyValue": false,
"schema": {
"type": "integer"
}
},
{
"name": "created_min",
"in": "query",
"description": "Created initial date",
"required": false,
"allowEmptyValue": false,
"schema": {
"title": "date_time",
"description": "The date and time",
"type": "string",
"format": "date-time",
"example": "YYYY-MM-DD hh:mm:ss"
}
},
{
"name": "created_max",
"in": "query",
"description": "Created finish",
"required": false,
"allowEmptyValue": false,
"schema": {
"title": "date_time",
"description": "The date and time",
"type": "string",
"format": "date-time",
"example": "YYYY-MM-DD hh:mm:ss"
}
},
{
"name": "updated_min",
"in": "query",
"description": "Updated initial",
"required": false,
"allowEmptyValue": false,
"schema": {
"title": "date_time",
"description": "The date and time",
"type": "string",
"format": "date-time",
"example": "YYYY-MM-DD hh:mm:ss"
}
},
{
"name": "updated_max",
"in": "query",
"description": "Updated finish",
"required": false,
"allowEmptyValue": false,
"schema": {
"title": "date_time",
"description": "The date and time",
"type": "string",
"format": "date-time",
"example": "YYYY-MM-DD hh:mm:ss"
}
},
{
"name": "start_date_min",
"in": "query",
"description": "Start date initial",
"required": false,
"allowEmptyValue": false,
"schema": {
"title": "date_time",
"description": "The date and time",
"type": "string",
"format": "date-time",
"example": "YYYY-MM-DD hh:mm:ss"
}
},
{
"name": "start_date_max",
"in": "query",
"description": "Start date finish",
"required": false,
"allowEmptyValue": false,
"schema": {
"title": "date_time",
"description": "The date and time",
"type": "string",
"format": "date-time",
"example": "YYYY-MM-DD hh:mm:ss"
}
},
{
"name": "end_date_min",
"in": "query",
"description": "End Date initial",
"required": false,
"allowEmptyValue": false,
"schema": {
"title": "date_time",
"description": "The date and time",
"type": "string",
"format": "date-time",
"example": "YYYY-MM-DD hh:mm:ss"
}
},
{
"name": "end_date_max",
"in": "query",
"description": "End Date finish",
"required": false,
"allowEmptyValue": false,
"schema": {
"title": "date_time",
"description": "The date and time",
"type": "string",
"format": "date-time",
"example": "YYYY-MM-DD hh:mm:ss"
}
},
{
"name": "schedule_date_min",
"in": "query",
"description": "Schedule Date initial",
"required": false,
"allowEmptyValue": false,
"schema": {
"title": "date_time",
"description": "The date and time",
"type": "string",
"format": "date-time",
"example": "YYYY-MM-DD hh:mm:ss"
}
},
{
"name": "schedule_date_max",
"in": "query",
"description": "Schedule Date finish",
"required": false,
"allowEmptyValue": false,
"schema": {
"title": "date_time",
"description": "The date and time",
"type": "string",
"format": "date-time",
"example": "YYYY-MM-DD hh:mm:ss"
}
},
{
"name": "offset",
"in": "query",
"description": "Element offset (starting at zero for the first element)",
"required": false,
"allowEmptyValue": false,
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "limit",
"in": "query",
"description": "Number of items to return",
"required": false,
"allowEmptyValue": false,
"schema": {
"type": "integer",
"default": 100,
"maximum": 1000,
"minimum": 1
}
},
{
"name": "order",
"in": "query",
"description": "Type of order",
"required": false,
"allowEmptyValue": false,
"schema": {
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
]
}
},
{
"name": "order_by",
"in": "query",
"description": "Reference attribute to order campaigns",
"required": false,
"allowEmptyValue": false,
"schema": {
"type": "string",
"default": "created",
"enum": [
"list_id",
"internal_name",
"created_by",
"group_id",
"created"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "CampaignsCollection",
"description": "Collection of Campaigns",
"properties": {
"total_items": {
"description": "Returned campaigns",
"type": "integer",
"minimum": 0,
"example": 1
},
"items": {
"description": "Returned campaigns",
"type": "array",
"items": {
"title": "Campaign",
"description": "Campaign schema",
"properties": {
"id": {
"title": "ID",
"type": "integer",
"minimum": 1,
"readOnly": true,
"example": 1
},
"campaign_hash": {
"title": "Hash",
"type": "string",
"pattern": "[a-zA-Z0-9_-]*",
"readOnly": true
},
"status": {
"description": "Status of the campaign",
"type": "string",
"enum": [
"draft",
"canceled",
"queued",
"paused",
"sending",
"sent"
],
"example": "sent"
},
"thumbnail": {
"description": "Thumbnail of the campaign",
"type": "string",
"example": "//bo29.e-goi.com/recursos/resource_folder/listas/name_image.jpg"
},
"channel": {
"description": "Channel of the campaign",
"type": "string",
"enum": [
"email",
"push",
"sms",
"smart_sms",
"voice",
"web_push"
],
"example": "email"
},
"internal_name": {
"description": "Internal name of the campaign",
"type": "string",
"example": "your internal name"
},
"list_id": {
"title": "ID",
"type": "integer",
"minimum": 1,
"readOnly": true,
"example": 1
},
"title": {
"description": "Subject of the campaign",
"type": "string",
"example": "subject of campaign"
},
"created_by": {
"title": "ID",
"type": "integer",
"minimum": 1,
"readOnly": true,
"example": 1
},
"group_id": {
"title": "ID",
"type": "integer",
"minimum": 1,
"readOnly": true,
"example": 1
},
"created": {
"allOf": [
{
"title": "date_time",
"description": "The date and time",
"type": "string",
"format": "date-time",
"example": "YYYY-MM-DD hh:mm:ss"
}
]
},
"updated": {
"allOf": [
{
"title": "date_time",
"description": "The date and time",
"type": "string",
"format": "date-time",
"example": "YYYY-MM-DD hh:mm:ss"
}
]
},
"start_date": {
"allOf": [
{
"title": "date_time",
"description": "The date and time",
"type": "string",
"format": "date-time",
"example": "YYYY-MM-DD hh:mm:ss"
}
]
},
"end_date": {
"allOf": [
{
"title": "date_time",
"description": "The date and time",
"type": "string",
"format": "date-time",
"example": "YYYY-MM-DD hh:mm:ss"
}
]
},
"schedule_date": {
"properties": {
"enabled": {
"description": "True if the campaign was scheduled",
"type": "boolean"
},
"date": {
"allOf": [
{
"title": "date_time",
"description": "The date and time",
"type": "string",
"format": "date-time",
"example": "YYYY-MM-DD hh:mm:ss"
}
]
}
},
"type": "object"
},
"processed_messages": {
"description": "Total number of processed messages",
"type": "integer",
"minimum": 0,
"example": 1
},
"automation_id": {
"description": "The automation id of the campaign",
"type": "integer",
"example": 1
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"title": "Unauthorized",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Unauthorized"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 401
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The request has not been applied because it lacks valid authentication credentials for the target resource"
}
},
"type": "object"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"title": "Forbidden",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Forbidden"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 403
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The server understood the request but refuses to authorize it"
}
},
"type": "object"
}
}
}
},
"408": {
"description": "Request Timeout",
"content": {
"application/json": {
"schema": {
"title": "Request Timeout",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Request Timeout"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 408
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The server did not receive a complete request from the client within the server’s allotted timeout period"
}
},
"type": "object"
}
}
}
},
"422": {
"description": "Unprocessable Entity",
"content": {
"application/json": {
"schema": {
"title": "Unprocessable Entity",
"properties": {
"errors": {
"description": "Information about the input validation",
"type": "object"
},
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Unprocessable Entity"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 422
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The server understands the content type of the request entity, and the syntax of the request entity is correct but was unable to process the contained instructions"
}
},
"type": "object"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"title": "Too Many Requests",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Too Many Requests"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 429
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The user has sent too many requests in a given amount of time"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"title": "Internal Server Error",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Internal Server Error"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 500
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The server encountered an unexpected condition that prevented it from fulfilling the request"
}
},
"type": "object"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"title": "Service Unavailable",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Service Unavailable"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 503
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, whichwill likely be alleviated after some delay"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"Apikey": []
}
],
"x-code-samples": [
{
"lang": "cURL",
"source": "curl --location --max-time 30 --request GET 'api.egoiapp.com/campaigns?channel=&campaign_hash=&list_id=&status=&internal_name=&created_by=&group_id=&created_min=&created_max=&updated_min=&updated_max=&start_date_min=&start_date_max=&end_date_min=&end_date_max=&schedule_date_min=&schedule_date_max=&offset=&limit=100&order=desc&order_by=created' \\\n--header 'Apikey: '"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"api.egoiapp.com/campaigns?channel=&campaign_hash=&list_id=&status=&internal_name=&created_by=&group_id=&created_min=&created_max=&updated_min=&updated_max=&start_date_min=&start_date_max=&end_date_min=&end_date_max=&schedule_date_min=&schedule_date_max=&offset=&limit=100&order=desc&order_by=created\");\nclient.Timeout = 30;\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Apikey\", \"\");\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient().newBuilder()\n .setConnectTimeout(30, TimeUnit.MILLISECONDS)\n .build();\nRequest request = new Request.Builder()\n .url(\"api.egoiapp.com/campaigns?channel=&campaign_hash=&list_id=&status=&internal_name=&created_by=&group_id=&created_min=&created_max=&updated_min=&updated_max=&start_date_min=&start_date_max=&end_date_min=&end_date_max=&schedule_date_min=&schedule_date_max=&offset=&limit=100&order=desc&order_by=created\")\n .method(\"GET\", null)\n .addHeader(\"Apikey\", \"\")\n .build();\nResponse response = client.newCall(request).execute();"
},
{
"lang": "JavaScript",
"source": "\nvar xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function() {\n if(this.readyState === 4) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"api.egoiapp.com/campaigns?channel=&campaign_hash=&list_id=&status=&internal_name=&created_by=&group_id=&created_min=&created_max=&updated_min=&updated_max=&start_date_min=&start_date_max=&end_date_min=&end_date_max=&schedule_date_min=&schedule_date_max=&offset=&limit=100&order=desc&order_by=created\");\nxhr.timeout = 30;\nxhr.addEventListener(\"ontimeout\", function(e) {\n console.log(e);\n});\nxhr.setRequestHeader(\"Apikey\", \"\");\n\nxhr.send();"
},
{
"lang": "PHP",
"source": " \"api.egoiapp.com/campaigns?channel=&campaign_hash=&list_id=&status=&internal_name=&created_by=&group_id=&created_min=&created_max=&updated_min=&updated_max=&start_date_min=&start_date_max=&end_date_min=&end_date_max=&schedule_date_min=&schedule_date_max=&offset=&limit=100&order=desc&order_by=created\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => array(\n \"Apikey: \"\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n"
},
{
"lang": "Python",
"source": "import http.client\nimport mimetypes\nconn = http.client.HTTPSConnection(\"api.egoiapp.com\", timeout = 30)\npayload = ''\nheaders = {\n 'Apikey': ''\n}\nconn.request(\"GET\", \"/campaigns?channel=&campaign_hash=&list_id=&status=&internal_name=&created_by=&group_id=&created_min=&created_max=&updated_min=&updated_max=&start_date_min=&start_date_max=&end_date_min=&end_date_max=&schedule_date_min=&schedule_date_max=&offset=&limit=100&order=desc&order_by=created\", payload, headers)\nres = conn.getresponse()\ndata = res.read()\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Ruby",
"source": "require \"uri\"\nrequire \"net/http\"\n\nurl = URI(\"api.egoiapp.com/campaigns?channel=&campaign_hash=&list_id=&status=&internal_name=&created_by=&group_id=&created_min=&created_max=&updated_min=&updated_max=&start_date_min=&start_date_max=&end_date_min=&end_date_max=&schedule_date_min=&schedule_date_max=&offset=&limit=100&order=desc&order_by=created\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nhttp.read_timeout = 1\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Apikey\"] = \"\"\n\nresponse = http.request(request)\nputs response.read_body\n"
}
]
}
},
"/campaigns/{campaign_hash}": {
"delete": {
"tags": [
"Campaigns"
],
"summary": "Remove Campaign",
"description": "Remove campaign information given its ID",
"operationId": "deleteCampaigns",
"parameters": [
{
"name": "campaign_hash",
"in": "path",
"description": "Hash of the Campaign",
"required": true,
"allowEmptyValue": false,
"schema": {
"title": "Hash",
"type": "string",
"pattern": "[a-zA-Z0-9_-]*",
"readOnly": true
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"title": "Unauthorized",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Unauthorized"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 401
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The request has not been applied because it lacks valid authentication credentials for the target resource"
}
},
"type": "object"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"title": "Forbidden",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Forbidden"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 403
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The server understood the request but refuses to authorize it"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"title": "Not Found",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"NotFound"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 404
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The origin server did not find a current representation for the target resource or is not willing to disclose that one exists"
}
},
"type": "object"
}
}
}
},
"408": {
"description": "Request Timeout",
"content": {
"application/json": {
"schema": {
"title": "Request Timeout",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Request Timeout"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 408
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The server did not receive a complete request from the client within the server’s allotted timeout period"
}
},
"type": "object"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"title": "DeleteCampaignsConflict",
"description": "Error schema for delete campaigns conflicts",
"type": "object",
"allOf": [
{
"title": "campaign_sent_last_30_days",
"description": "Error schema for conflict when the campaign was sent in the last 30 days",
"properties": {
"errors": {
"properties": {
"campaign_sent_last_30_days": {
"description": "Occurs when the campaign was sent in the last 30 days",
"type": "string",
"enum": [
"This campaign cant be deleted since it was sent in the last 30 days"
]
}
},
"type": "object"
}
},
"type": "object"
},
{
"title": "BaseConflict",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Conflict"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 409
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The request could not be completed due to a conflict with the current state of the target resource"
}
},
"type": "object"
}
]
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"title": "Too Many Requests",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Too Many Requests"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 429
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The user has sent too many requests in a given amount of time"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"title": "Internal Server Error",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Internal Server Error"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 500
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The server encountered an unexpected condition that prevented it from fulfilling the request"
}
},
"type": "object"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"title": "Service Unavailable",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Service Unavailable"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 503
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, whichwill likely be alleviated after some delay"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"Apikey": []
}
],
"x-code-samples": [
{
"lang": "cURL",
"source": "curl --location --max-time 30 --request DELETE 'api.egoiapp.com/campaigns/' \\\n--header 'Apikey: '"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"api.egoiapp.com/campaigns/\");\nclient.Timeout = 30;\nvar request = new RestRequest(Method.DELETE);\nrequest.AddHeader(\"Apikey\", \"\");\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient().newBuilder()\n .setConnectTimeout(30, TimeUnit.MILLISECONDS)\n .build();\nMediaType mediaType = MediaType.parse(\"text/plain\");\nRequestBody body = RequestBody.create(mediaType, \"\");\nRequest request = new Request.Builder()\n .url(\"api.egoiapp.com/campaigns/\")\n .method(\"DELETE\", body)\n .addHeader(\"Apikey\", \"\")\n .build();\nResponse response = client.newCall(request).execute();"
},
{
"lang": "JavaScript",
"source": "\nvar xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function() {\n if(this.readyState === 4) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"api.egoiapp.com/campaigns/\");\nxhr.timeout = 30;\nxhr.addEventListener(\"ontimeout\", function(e) {\n console.log(e);\n});\nxhr.setRequestHeader(\"Apikey\", \"\");\n\nxhr.send();"
},
{
"lang": "PHP",
"source": " \"api.egoiapp.com/campaigns/\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"DELETE\",\n CURLOPT_HTTPHEADER => array(\n \"Apikey: \"\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n"
},
{
"lang": "Python",
"source": "import http.client\nimport mimetypes\nconn = http.client.HTTPSConnection(\"api.egoiapp.com\", timeout = 30)\npayload = ''\nheaders = {\n 'Apikey': ''\n}\nconn.request(\"DELETE\", \"/campaigns/\", payload, headers)\nres = conn.getresponse()\ndata = res.read()\nprint(data.decode(\"utf-8\"))"
},
{
"lang": "Ruby",
"source": "require \"uri\"\nrequire \"net/http\"\n\nurl = URI(\"api.egoiapp.com/campaigns/\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nhttp.read_timeout = 1\nrequest = Net::HTTP::Delete.new(url)\nrequest[\"Apikey\"] = \"\"\n\nresponse = http.request(request)\nputs response.read_body\n"
}
]
}
},
"/campaigns/email/{campaign_hash}/actions/send": {
"post": {
"tags": [
"Email"
],
"summary": "Send email message",
"description": "Deploys and sends an email message",
"operationId": "actionSendEmail",
"parameters": [
{
"name": "campaign_hash",
"in": "path",
"description": "Hash of the Campaign",
"required": true,
"allowEmptyValue": false,
"schema": {
"title": "Hash",
"type": "string",
"pattern": "[a-zA-Z0-9_-]*",
"readOnly": true
}
}
],
"requestBody": {
"description": "Parameters for the 'send email' action",
"required": true,
"content": {
"application/json": {
"schema": {
"title": "Send Email",
"description": "Campaign email send request schema",
"type": "object",
"oneOf": [
{
"title": "Send Email",
"description": "Campaign email send now request schema",
"required": [
"list_id"
],
"type": "object",
"allOf": [
{
"title": "Abstract Send Email",
"description": "Campaign email abstract schema",
"required": [
"list_id",
"segments"
],
"properties": {
"list_id": {
"title": "ID",
"type": "integer",
"minimum": 1,
"example": 1
},
"segments": {
"title": "EmailSendSegment",
"description": "Send segment schema for email",
"type": "object",
"discriminator": {
"propertyName": "type",
"mapping": {
"none": "#/components/schemas/SendNone",
"segment": "#/components/schemas/SendSegment",
"contact": "#/components/schemas/SendEmailContact"
}
},
"oneOf": [
{
"title": "SendNone",
"description": "Sends the campaign to the whole list",
"required": [
"type"
],
"properties": {
"type": {
"description": "Use this segment type to send to the whole list",
"type": "string",
"enum": [
"none"
]
}
},
"type": "object",
"discriminator": {
"propertyName": "type"
}
},
{
"title": "SendSegment",
"description": "Segments where the campaign will be sent",
"required": [
"type",
"data"
],
"properties": {
"type": {
"description": "Use this segment type to send to specific segments",
"type": "string",
"enum": [
"segment"
]
},
"data": {
"description": "Array of segment IDs to send the campaign",
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object",
"discriminator": {
"propertyName": "type"
}
},
{
"title": "SendEmailContact",
"description": "Email contact to whom the campaign will be sent",
"required": [
"type",
"data"
],
"properties": {
"type": {
"description": "Use this segment type to send to a specific contact",
"type": "string",
"enum": [
"contact"
]
},
"data": {
"description": "Contact to send the campaign",
"type": "string",
"format": "email"
}
},
"type": "object",
"discriminator": {
"propertyName": "type"
}
}
]
},
"notify": {
"description": "Array of IDs of the users to notify",
"type": "array",
"items": {
"type": "integer"
}
},
"destination_field": {
"description": "Destination field of this campaign, which must be an email field (email or extra field id).\n If not sent, defaults to the general email field",
"type": "string"
},
"unique_contacts_only": {
"description": "True to send the campaign only to unique contacts",
"type": "boolean",
"default": false
}
},
"type": "object"
},
{
"title": "Hour limit",
"description": "Selection of hour interval",
"properties": {
"limit_hour": {
"description": "Hour limit to send the campaign",
"properties": {
"hour_start": {
"description": "Hour start limit",
"type": "string",
"pattern": "^([0-9]|0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$",
"example": "13:00"
},
"hour_end": {
"description": "Hour end limit",
"type": "string",
"pattern": "^([0-9]|0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$",
"example": "15:00"
}
},
"type": "object"
}
},
"type": "object"
}
]
},
{
"title": "Schedule Email",
"description": "Campaign email schedule request schema",
"required": [
"list_id"
],
"type": "object",
"allOf": [
{
"properties": {
"schedule_date": {
"title": "date_time",
"description": "The date and time",
"type": "string",
"format": "date-time",
"example": "YYYY-MM-DD hh:mm:ss"
}
},
"type": "object"
},
{
"title": "Abstract Send Email",
"description": "Campaign email abstract schema",
"required": [
"list_id",
"segments"
],
"properties": {
"list_id": {
"title": "ID",
"type": "integer",
"minimum": 1,
"example": 1
},
"segments": {
"title": "EmailSendSegment",
"description": "Send segment schema for email",
"type": "object",
"discriminator": {
"propertyName": "type",
"mapping": {
"none": "#/components/schemas/SendNone",
"segment": "#/components/schemas/SendSegment",
"contact": "#/components/schemas/SendEmailContact"
}
},
"oneOf": [
{
"title": "SendNone",
"description": "Sends the campaign to the whole list",
"required": [
"type"
],
"properties": {
"type": {
"description": "Use this segment type to send to the whole list",
"type": "string",
"enum": [
"none"
]
}
},
"type": "object",
"discriminator": {
"propertyName": "type"
}
},
{
"title": "SendSegment",
"description": "Segments where the campaign will be sent",
"required": [
"type",
"data"
],
"properties": {
"type": {
"description": "Use this segment type to send to specific segments",
"type": "string",
"enum": [
"segment"
]
},
"data": {
"description": "Array of segment IDs to send the campaign",
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object",
"discriminator": {
"propertyName": "type"
}
},
{
"title": "SendEmailContact",
"description": "Email contact to whom the campaign will be sent",
"required": [
"type",
"data"
],
"properties": {
"type": {
"description": "Use this segment type to send to a specific contact",
"type": "string",
"enum": [
"contact"
]
},
"data": {
"description": "Contact to send the campaign",
"type": "string",
"format": "email"
}
},
"type": "object",
"discriminator": {
"propertyName": "type"
}
}
]
},
"notify": {
"description": "Array of IDs of the users to notify",
"type": "array",
"items": {
"type": "integer"
}
},
"destination_field": {
"description": "Destination field of this campaign, which must be an email field (email or extra field id).\n If not sent, defaults to the general email field",
"type": "string"
},
"unique_contacts_only": {
"description": "True to send the campaign only to unique contacts",
"type": "boolean",
"default": false
}
},
"type": "object"
}
]
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "AcceptedResponse",
"description": "Accepted response schema",
"properties": {
"result": {
"type": "string",
"enum": [
"success"
]
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"title": "Bad Request",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Bad Request"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 400
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The server cannot or will not process the request due to something that is perceived to be a client error"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"title": "Unauthorized",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Unauthorized"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 401
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The request has not been applied because it lacks valid authentication credentials for the target resource"
}
},
"type": "object"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"title": "Forbidden",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Forbidden"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 403
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The server understood the request but refuses to authorize it"
}
},
"type": "object"
}
}
}
},
"408": {
"description": "Request Timeout",
"content": {
"application/json": {
"schema": {
"title": "Request Timeout",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Request Timeout"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 408
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The server did not receive a complete request from the client within the server’s allotted timeout period"
}
},
"type": "object"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"title": "DeleteCampaignsConflict",
"description": "Error schema for delete campaigns conflicts",
"type": "object",
"allOf": [
{
"title": "campaign_sent_last_30_days",
"description": "Error schema for conflict when the campaign was sent in the last 30 days",
"properties": {
"errors": {
"properties": {
"campaign_sent_last_30_days": {
"description": "Occurs when the campaign was sent in the last 30 days",
"type": "string",
"enum": [
"This campaign cant be deleted since it was sent in the last 30 days"
]
}
},
"type": "object"
}
},
"type": "object"
},
{
"title": "BaseConflict",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Conflict"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 409
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The request could not be completed due to a conflict with the current state of the target resource"
}
},
"type": "object"
}
]
}
}
}
},
"422": {
"description": "Unprocessable Entity",
"content": {
"application/json": {
"schema": {
"title": "Unprocessable Entity",
"properties": {
"errors": {
"description": "Information about the input validation",
"type": "object"
},
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Unprocessable Entity"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 422
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The server understands the content type of the request entity, and the syntax of the request entity is correct but was unable to process the contained instructions"
}
},
"type": "object"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"title": "Too Many Requests",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Too Many Requests"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 429
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The user has sent too many requests in a given amount of time"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"title": "Internal Server Error",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Internal Server Error"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 500
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The server encountered an unexpected condition that prevented it from fulfilling the request"
}
},
"type": "object"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"title": "Service Unavailable",
"properties": {
"type": {
"description": "RFC for status code definitions",
"type": "string",
"example": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
},
"title": {
"description": "Error title",
"type": "string",
"enum": [
"Service Unavailable"
]
},
"status": {
"description": "Status code",
"type": "integer",
"example": 503
},
"detail": {
"description": "Error detail",
"type": "string",
"example": "The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, whichwill likely be alleviated after some delay"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"Apikey": []
}
],
"x-code-samples": [
{
"lang": "cURL",
"source": "curl --location --max-time 30 --request POST 'api.egoiapp.com/campaigns/email//actions/send' \\\n--header 'Apikey: ' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\"list_id\":\"\",\"segments\":{\"type\":\"\"},\"notify\":[\"\",\"\"],\"destination_field\":\"\",\"unique_contacts_only\":false,\"limit_hour\":{\"hour_start\":\"\",\"hour_end\":\"\"}}'"
},
{
"lang": "C#",
"source": "var client = new RestClient(\"api.egoiapp.com/campaigns/email//actions/send\");\nclient.Timeout = 30;\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Apikey\", \"\");\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddParameter(\"application/json\", \"{\\\"list_id\\\":\\\"\\\",\\\"segments\\\":{\\\"type\\\":\\\"\\\"},\\\"notify\\\":[\\\"\\\",\\\"\\\"],\\\"destination_field\\\":\\\"\\\",\\\"unique_contacts_only\\\":false,\\\"limit_hour\\\":{\\\"hour_start\\\":\\\"\\\",\\\"hour_end\\\":\\\"\\\"}}\", ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);"
},
{
"lang": "Java",
"source": "OkHttpClient client = new OkHttpClient().newBuilder()\n .setConnectTimeout(30, TimeUnit.MILLISECONDS)\n .build();\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"list_id\\\":\\\"\\\",\\\"segments\\\":{\\\"type\\\":\\\"\\\"},\\\"notify\\\":[\\\"