Welcome to the E-goi Marketing API!

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.

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.

Explore the documentation to discover all the possibilities and start creating integrations that drive your marketing results.

E-goi can be integrated with many environments and programming languages via our REST API. We've created a developer focused portal to give your organization a clear and quick overview of how to integrate with E-goi. The 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.

The E-goi APIv3 is served over HTTPS. To ensure data privacy, unencrypted HTTP is not supported.

Request data is passed to the API by POSTing JSON objects to the API endpoints with the appropriate parameters.

BaseURL = api.egoiapp.com

This API supports 5 HTTP methods:

• GET: The HTTP GET method is used to read (or retrieve) a representation of a resource.
• POST: The POST verb is most-often utilized to create new resources.
• PATCH: PATCH is used for modify capabilities. The PATCH request only needs to contain the changes to the resource, not the complete resource
• PUT: PUT 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.
• DELETE: DELETE is pretty easy to understand. It is used to delete a resource identified by a URI.

Transport 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.
Our API requires TLS 1.2 or TLS 1.3. We recommend TLS 1.3.

TLS 1.3 ciphers

• TLS_AES_256_GCM_SHA384 (0x1302) ECDH x25519 (eq. 3072 bits RSA) FS
• TLS_CHACHA20_POLY1305_SHA256 (0x1303) ECDH x25519 (eq. 3072 bits RSA) FS
• TLS_AES_128_GCM_SHA256 (0x1301) ECDH x25519 (eq. 3072 bits RSA) FS

TLS 1.2 ciphers

• TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (0xc030) ECDH x25519 (eq. 3072 bits RSA) FS
• TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 (0xc02f) ECDH x25519 (eq. 3072 bits RSA) FS
• TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 (0x9f) DH 4096 bits FS
• TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 (0x9e) DH 4096 bits FS

Rate limits are used to control the amount of traffic that is allowed to flow between the client and the server.
This is done to prevent abuse and ensure that the API is available to all users.
The 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.
If the rate limit is exceeded, the API will return a 429 status code and the request will be rejected.
Each API response includes headers providing real-time rate limit information:

• X-RateLimit-Limit: The maximum number of requests that the consumer is permitted to make in a given time period.
• X-RateLimit-Remaining: The number of requests remaining in the current rate limit window.
• X-RateLimit-Reset: The remaining time in seconds until the rate limit window resets.

The account limit is a rate limit that is applied to the account as a whole.
This limit is applied to all requests made by the account, regardless of the client making the request.
The account limit is applied to ensure that the account does not exceed the maximum number of requests allowed in a given time period. Each 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.
Each API response includes headers providing real-time rate limit information:

• X-Account-Limit: The maximum number of requests that the account is permitted to make in a given time period.
• X-Account-Remaining: The number of requests remaining in the current rate limit window.
• X-Account-Reset: The remaining time in seconds until the rate limit window resets.

We 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: #!/bin/bash curl -X GET 'https://api.egoiapp.com/my-account'
-H 'accept: application/json'
-H 'Apikey: '

Here you can see a curl Post example with authentication: #!/bin/bash curl -X POST 'http://api.egoiapp.com/tags'
-H 'accept: application/json'
-H 'Apikey: '
-H 'Content-Type: application/json'
-d '{name:Your custom tag,color:#FFFFFF}'

Get 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.

• Java
• PHP
• Python
• Ruby
• Javascript
• C#

Stream 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.

Timeouts 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.

For 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.

A 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.

The 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.

[Go to callbacks documentation]

Note: Only http or https protocols are supported in the Url parameter.

Getting started:

To start sending push notifications you simply have to integrate with our server and import our libraries. Follow the link to find out how! https://developers.e-goi.com/push/