Unisender Go

https://godocs.unisender.ru
Admin
Unisender Go is an email service that provides tools and APIs for sending transactional and...
Tokens:93,152
Snippets:462
Trust Score:7.7
Update:1 month ago
Show doc for...
Tokens:
Raw
### API Response Example

Source: https://godocs.unisender.ru/web-api-ref

Example of a successful JSON response from the tag list endpoint.

```json
{
  "status": "success",
  "tags": [
    {
      "tag_id": 54,
      "tag": "example-tag1"
    }
  ]
}
```

--------------------------------

### Update Project Properties

Source: https://godocs.unisender.ru/web-api-ref

Examples for updating project settings using various programming languages.

```ruby
require 'rest-client'  
require 'json'  
  
headers = {  
  'Content-Type' => 'application/json',  
  'Accept' => 'application/json',  
  'X-API-KEY' => 'API_KEY'  
}  
  
params = {  
  "project_id" => 1234567890,  
  "project_api_key" => "your api_key",  
  "project" => {  
    "name" => "Project 1A",  
    "country" => "ES",  
    "send_enabled" => true,  
    "custom_unsubscribe_url_enabled" => true,  
    "backend_domain_id" => 1234,  
    "unsubscribe_page_id" => 1,  
    "email_counter" => 0,  
    "email_counter_limit" => 0,  
    "email_counter_mode" => "default"  
  }  
}  
  
begin  
  result = RestClient.post(  
    'https://goapi.unisender.ru/ru/transactional/api/v1/project/update.json',  
    params.to_json,  
    headers  
  )  
  
  p JSON.parse(result)  
rescue RestClient::ExceptionWithResponse => e  
  puts e.response.code  
  puts e.response.body  
end
```

```csharp
using System;  
using System.IO;  
using System.Text;  
using System.Net.Http;  
using System.Net.Http.Headers;  
  
class Program {  
  static HttpClient client;  
  
  public static void Main(string[] args) {  
    client = new HttpClient();  
  
    client.BaseAddress = new Uri("https://goapi.unisender.ru/ru/transactional/api/v1/");  
    client.DefaultRequestHeaders.Add("X-API-KEY", "API_KEY");  
    client.DefaultRequestHeaders.Accept.Add(  
      new MediaTypeWithQualityHeaderValue("application/json"));  
  
    string requestBody = "{"  
    +"  \"project_id\": 1234567890,"  
    +"  \"project_api_key\": \"your api_key\","  
    +"  \"project\": {"  
    +"    \"name\": \"Project 1A\","  
    +"    \"country\": \"ES\","  
    +"    \"send_enabled\": true,"  
    +"    \"custom_unsubscribe_url_enabled\": true,"  
    +"    \"backend_domain_id\": 1234,"  
    +"    \"unsubscribe_page_id\": 1,"  
    +"    \"email_counter\": 0,"  
    +"    \"email_counter_limit\": 0,"  
    +"    \"email_counter_mode\": \"default\""  
    +"  }"  
    +"}";  
    var content = new StringContent(requestBody, Encoding.UTF8, "application/json");  
  
    var response = client.PostAsync("project/update.json", content).Result;  
    var responseBody = response.Content.ReadAsStringAsync().Result;  
    if(response.IsSuccessStatusCode) {  
        Console.WriteLine(responseBody);  
    }  
    else {  
      Console.WriteLine(String.Format("Request failed (HTTP {0}): {1}",  
        (int)response.StatusCode, responseBody));  
    }  
  }  
}
```

```java
URL obj = new URL("https://goapi.unisender.ru/ru/transactional/api/v1/project/update.json");  
HttpURLConnection con = (HttpURLConnection) obj.openConnection();  
con.setRequestMethod("POST");  
con.setRequestProperty("Content-Type", "application/json");  
con.setRequestProperty("Accept", "application/json");  
con.setRequestProperty("X-API-KEY", "API_KEY");  
con.setDoOutput(true);  
String requestBody = "{"  
    +"  \"project_id\": 1234567890,"  
    +"  \"project_api_key\": \"your api_key\","  
    +"  \"project\": {"  
    +"    \"name\": \"Project 1A\","  
    +"    \"country\": \"ES\","  
    +"    \"send_enabled\": true,"  
    +"    \"custom_unsubscribe_url_enabled\": true,"  
    +"    \"backend_domain_id\": 1234,"  
    +"    \"unsubscribe_page_id\": 1,"  
    +"    \"email_counter\": 0,"  
    +"    \"email_counter_limit\": 0,"  
    +"    \"email_counter_mode\": \"default\""  
    +"  }"  
    +"}";  
  
try (OutputStream out = con.getOutputStream()) {   
    out.write(requestBody.getBytes());  
    out.flush();  
}  
int responseCode = con.getResponseCode();  
BufferedReader in = new BufferedReader(  
    new InputStreamReader(con.getInputStream()));  
String inputLine;  
StringBuffer response = new StringBuffer();  
while ((inputLine = in.readLine()) != null) {  
    response.append(inputLine);  
}  
in.close();  
System.out.println(responseCode);  
System.out.println(response.toString());
```

```javascript
const fetch = require('node-fetch');  
const headers = {  
  'Content-Type':'application/json',  
  'Accept':'application/json',  
  'X-API-KEY':'API_KEY'  
};  
  
const inputBody = {  
  "project_id": 1234567890,  
  "project_api_key": "your api_key",  
  "project": {  
    "name": "Project 1A",  
    "country": "ES",  
    "send_enabled": true,  
    "custom_unsubscribe_url_enabled": true,  
    "backend_domain_id": 1234,  
    "unsubscribe_page_id": 1,  
    "email_counter": 0,  
    "email_counter_limit": 0,  
    "email_counter_mode": "default"  
  }  
};  
fetch('https://goapi.unisender.ru/ru/transactional/api/v1/project/update.json',  
{  
  method: 'POST',  
  body: JSON.stringify(inputBody),  
  headers: headers  
})  
.then(function(res) {  
    return res.json();  
}).then(function(body) {  
    console.log(body);  
});
```

--------------------------------

### Example Response for event-dump/list

Source: https://godocs.unisender.ru/web-api-ref

The JSON structure returned upon a successful request.

```json
{
  "status": "success",
  "event_dumps": [
    {
      "dump_id": "Gqfasjh34tlasd",
      "dump_status": "in_process",
      "files": [
        {
          "url": "https://go2.unisender.ru/event-dump/Agejmh63Efmngaow4tDFGqwqt-1.csv",
          "size": 512345
        }
      ]
    }
  ]
}
```

--------------------------------

### Delete Webhook Implementation Examples

Source: https://godocs.unisender.ru/web-api-ref

Code examples for deleting a webhook across various programming languages.

```php
<?php  
  
require 'vendor/autoload.php';  
  
$headers = array(  
    'Content-Type' => 'application/json',  
    'Accept' => 'application/json',  
    'X-API-KEY' => 'API_KEY',  
);  
  
$client = new \GuzzleHttp\Client([  
    'base_uri' => 'https://goapi.unisender.ru/ru/transactional/api/v1/'  
]);  
  
$requestBody = [  
  "url" => "https://example.com/webhook"  
];  
  
try {  
    $response = $client->request('POST','webhook/delete.json', array(  
        'headers' => $headers,  
        'json' => $requestBody,  
       )  
    );  
    print_r($response->getBody()->getContents());  
 }  
 catch (\GuzzleHttp\Exception\BadResponseException $e) {  
    // handle exception or api errors.  
    print_r($e->getMessage());  
 }  
  
 // ...  
```

```python
import requests  
  
base_url = 'https://goapi.unisender.ru/ru/transactional/api/v1'  
headers = {  
  'Content-Type': 'application/json',  
  'Accept': 'application/json',  
  'X-API-KEY': 'API_KEY'  
}  
  
request_body = {  
  "url": "https://example.com/webhook"  
}  
r = requests.post(base_url+'/webhook/delete.json', json=request_body, headers=headers)  
r.raise_for_status()  # throw an exception in case of error  
print(r.json())  
```

```ruby
require 'rest-client'  
require 'json'  
  
headers = {  
  'Content-Type' => 'application/json',  
  'Accept' => 'application/json',  
  'X-API-KEY' => 'API_KEY'  
}  
  
params = {  
  "url" => "https://example.com/webhook"  
}  
  
begin  
  result = RestClient.post(  
    'https://goapi.unisender.ru/ru/transactional/api/v1/webhook/delete.json',  
    params.to_json,  
    headers  
  )  
  
  p JSON.parse(result)  
rescue RestClient::ExceptionWithResponse => e  
  puts e.response.code  
  puts e.response.body  
end  
```

```csharp
using System;  
using System.IO;  
using System.Text;  
using System.Net.Http;  
using System.Net.Http.Headers;  
  
class Program {  
  static HttpClient client;  
  
  public static void Main(string[] args) {  
    client = new HttpClient();  
  
    client.BaseAddress = new Uri("https://goapi.unisender.ru/ru/transactional/api/v1/");  
    client.DefaultRequestHeaders.Add("X-API-KEY", "API_KEY");  
    client.DefaultRequestHeaders.Accept.Add(  
      new MediaTypeWithQualityHeaderValue("application/json"));  
  
    string requestBody = "{"  
    +"  \"url\": \"https://example.com/webhook\""  
    +"}";  
    var content = new StringContent(requestBody, Encoding.UTF8, "application/json");  
  
    var response = client.PostAsync("webhook/delete.json", content).Result;  
    var responseBody = response.Content.ReadAsStringAsync().Result;  
    if(response.IsSuccessStatusCode) {  
        Console.WriteLine(responseBody);  
    }  
    else {  
      Console.WriteLine(String.Format("Request failed (HTTP {0}): {1}",  
        (int)response.StatusCode, responseBody));  
    }  
  }  
}  
```

```java
URL obj = new URL("https://goapi.unisender.ru/ru/transactional/api/v1/webhook/delete.json");  
HttpURLConnection con = (HttpURLConnection) obj.openConnection();  
con.setRequestMethod("POST");  
con.setRequestProperty("Content-Type", "application/json");  
con.setRequestProperty("Accept", "application/json");  
con.setRequestProperty("X-API-KEY", "API_KEY");  
con.setDoOutput(true);  
String requestBody = "{"  
    +"  \"url\": \"https://example.com/webhook\""  
    +"}";  
  
try (OutputStream out = con.getOutputStream()) {   
    out.write(requestBody.getBytes());  
    out.flush();  
}  
int responseCode = con.getResponseCode();  
BufferedReader in = new BufferedReader(  
    new InputStreamReader(con.getInputStream()));  
String inputLine;  
StringBuffer response = new StringBuffer();  
while ((inputLine = in.readLine()) != null) {  
    response.append(inputLine);  
}  
in.close();  
System.out.println(responseCode);  
System.out.println(response.toString());  
```

```javascript
const fetch = require('node-fetch');  
const headers = {  
  'Content-Type':'application/json',  
  'Accept':'application/json',  
  'X-API-KEY':'API_KEY'  
};  
  
const inputBody = {  
  "url": "https://example.com/webhook"  
};  
fetch('https://goapi.unisender.ru/ru/transactional/api/v1/webhook/delete.json',  
{  
  method: 'POST',  
  body: JSON.stringify(inputBody),  
  headers: headers  
})  
.then(function(res) {  
    return res.json();  
}).then(function(body) {  
    console.log(body);  
});  
```

--------------------------------

### Configure Webhooks via API

Source: https://godocs.unisender.ru/web-api-ref

Examples for setting up webhook endpoints and event subscriptions using HTTP, PHP, and Python.

```http
POST https://goapi.unisender.ru/ru/transactional/api/v1/webhook/set.json HTTP/1.1  
Host: goapi.unisender.ru  
Content-Type: application/json  
Accept: application/json  
  
{  
  "url": "https://yourhost.example.com/unisender-go-webhook",  
  "status": "active",  
  "event_format": "json_post",  
  "delivery_info": 0,  
  "single_event": 0,  
  "max_parallel": 10,  
  "events": {  
    "spam_block": [  
      "*"  
    ],  
    "email_status": [  
      "delivered",  
      "opened",  
      "clicked",  
      "unsubscribed",  
      "subscribed",  
      "soft_bounced",  
      "hard_bounced",  
      "spam"  
    ]  
  }  
}  
```

```php
<?php  
  
require 'vendor/autoload.php';  
  
$headers = array(  
    'Content-Type' => 'application/json',  
    'Accept' => 'application/json',  
    'X-API-KEY' => 'API_KEY',  
);  
  
$client = new \GuzzleHttp\Client([  
    'base_uri' => 'https://goapi.unisender.ru/ru/transactional/api/v1/'  
]);  
  
$requestBody = [  
  "url" => "https://yourhost.example.com/unisender-go-webhook",  
  "status" => "active",  
  "event_format" => "json_post",  
  "delivery_info" => 0,  
  "single_event" => 0,  
  "max_parallel" => 10,  
  "events" => [  
    "spam_block" => [  
      "*"  
    ],  
    "email_status" => [  
      "delivered",  
      "opened",  
      "clicked",  
      "unsubscribed",  
      "subscribed",  
      "soft_bounced",  
      "hard_bounced",  
      "spam"  
    ]  
  ]  
];  
  
try {  
    $response = $client->request('POST','webhook/set.json', array(  
        'headers' => $headers,  
        'json' => $requestBody,  
       )  
    );  
    print_r($response->getBody()->getContents());  
 }  
 catch (\GuzzleHttp\Exception\BadResponseException $e) {  
    // handle exception or api errors.  
    print_r($e->getMessage());  
 }  
  
 // ...  
```

```python
import requests  
  
base_url = 'https://goapi.unisender.ru/ru/transactional/api/v1'  
headers = {  
  'Content-Type': 'application/json',  
  'Accept': 'application/json',  
  'X-API-KEY': 'API_KEY'  
}  
  
request_body = {  
  "url": "https://yourhost.example.com/unisender-go-webhook",  
  "status": "active",  
  "event_format": "json_post",  
  "delivery_info": 0,  
  "single_event": 0,  
  "max_parallel": 10,  
  "events": {  
    "spam_block": [  
      "*"  
    ],  
    "email_status": [  
      "delivered",  
      "opened",  
      "clicked",  
      "unsubscribed",  
      "subscribed",  
      "soft_bounced",  
      "hard_bounced",  
      "spam"  
    ]  
  }  
}  
r = requests.post(base_url+'/webhook/set.json', json=request_body, headers=headers)  
r.raise_for_status()  # throw an exception in case of error  
print(r.json())  
```

--------------------------------

### Delete Domain Implementation Examples

Source: https://godocs.unisender.ru/web-api-ref

Client-side implementations for deleting a domain across various programming languages.

```php
<?php  
  
require 'vendor/autoload.php';  
  
$headers = array(  
    'Content-Type' => 'application/json',  
    'Accept' => 'application/json',  
    'X-API-KEY' => 'API_KEY',  
);  
  
$client = new \GuzzleHttp\Client([  
    'base_uri' => 'https://goapi.unisender.ru/ru/transactional/api/v1/'  
]);  
  
$requestBody = [  
  "domain" => "example.com"  
];  
  
try {  
    $response = $client->request('POST','domain/delete.json', array(  
        'headers' => $headers,  
        'json' => $requestBody,  
       )  
    );  
    print_r($response->getBody()->getContents());  
 }  
 catch (\GuzzleHttp\Exception\BadResponseException $e) {  
    // handle exception or api errors.  
    print_r($e->getMessage());  
 }  
  
 // ...  
```

```python
import requests  
  
base_url = 'https://goapi.unisender.ru/ru/transactional/api/v1'  
headers = {  
  'Content-Type': 'application/json',  
  'Accept': 'application/json',  
  'X-API-KEY': 'API_KEY'  
}  
  
request_body = {  
  "domain": "example.com"  
}  
r = requests.post(base_url+'/domain/delete.json', json=request_body, headers=headers)  
r.raise_for_status()  # throw an exception in case of error  
print(r.json())  
```

```ruby
require 'rest-client'  
require 'json'  
  
headers = {  
  'Content-Type' => 'application/json',  
  'Accept' => 'application/json',  
  'X-API-KEY' => 'API_KEY'  
}  
  
params = {  
  "domain" => "example.com"  
}  
  
begin  
  result = RestClient.post(  
    'https://goapi.unisender.ru/ru/transactional/api/v1/domain/delete.json',  
    params.to_json,  
    headers  
  )  
  
  p JSON.parse(result)  
rescue RestClient::ExceptionWithResponse => e  
  puts e.response.code  
  puts e.response.body  
end  
```

```csharp
using System;  
using System.IO;  
using System.Text;  
using System.Net.Http;  
using System.Net.Http.Headers;  
  
class Program {  
  static HttpClient client;  
  
  public static void Main(string[] args) {  
    client = new HttpClient();  
  
    client.BaseAddress = new Uri("https://goapi.unisender.ru/ru/transactional/api/v1/");  
    client.DefaultRequestHeaders.Add("X-API-KEY", "API_KEY");  
    client.DefaultRequestHeaders.Accept.Add(  
      new MediaTypeWithQualityHeaderValue("application/json"));  
  
    string requestBody = "{"  
    +"  \"domain\": \"example.com\""  
    +"}";  
    var content = new StringContent(requestBody, Encoding.UTF8, "application/json");  
  
    var response = client.PostAsync("domain/delete.json", content).Result;  
    var responseBody = response.Content.ReadAsStringAsync().Result;  
    if(response.IsSuccessStatusCode) {  
        Console.WriteLine(responseBody);  
    }  
    else {  
      Console.WriteLine(String.Format("Request failed (HTTP {0}): {1}",  
        (int)response.StatusCode, responseBody));  
    }  
  }  
}  
```

```java
URL obj = new URL("https://goapi.unisender.ru/ru/transactional/api/v1/domain/delete.json");  
HttpURLConnection con = (HttpURLConnection) obj.openConnection();  
con.setRequestMethod("POST");  
con.setRequestProperty("Content-Type", "application/json");  
con.setRequestProperty("Accept", "application/json");  
con.setRequestProperty("X-API-KEY", "API_KEY");  
con.setDoOutput(true);  
String requestBody = "{"  
    +"  \"domain\": \"example.com\""  
    +"}";  
  
try (OutputStream out = con.getOutputStream()) {   
    out.write(requestBody.getBytes());  
    out.flush();  
}  
int responseCode = con.getResponseCode();  
BufferedReader in = new BufferedReader(  
    new InputStreamReader(con.getInputStream()));  
String inputLine;  
StringBuffer response = new StringBuffer();  
while ((inputLine = in.readLine()) != null) {  
    response.append(inputLine);  
}  
in.close();  
System.out.println(responseCode);  
System.out.println(response.toString());  
```

```javascript
const fetch = require('node-fetch');  
const headers = {  
  'Content-Type':'application/json',  
  'Accept':'application/json',  
  'X-API-KEY':'API_KEY'  
};  
  
const inputBody = {  
  "domain": "example.com"  
};  
fetch('https://goapi.unisender.ru/ru/transactional/api/v1/domain/delete.json',  
{  
  method: 'POST',  
  body: JSON.stringify(inputBody),  
  headers: headers  
})  
.then(function(res) {  
    return res.json();  
}).then(function(body) {  
    console.log(body);  
});  
```

--------------------------------

### Success Response Example

Source: https://godocs.unisender.ru/web-api-ref

The JSON structure returned upon a successful request.

```json
{
  "status": "success"
}
```

--------------------------------

### Email Subscribe API Implementation

Source: https://godocs.unisender.ru/web-api-ref

Examples for subscribing an email address using the Unisender Go transactional API.

```http
POST https://goapi.unisender.ru/ru/transactional/api/v1/email/subscribe.json HTTP/1.1  
Host: goapi.unisender.ru  
Content-Type: application/json  
Accept: application/json  
  
{  
  "from_email": "email@example.com",  
  "from_name": "Example",  
  "to_email": "email@example.com"  
}  
```

```php
<?php  
  
require 'vendor/autoload.php';  
  
$headers = array(  
    'Content-Type' => 'application/json',  
    'Accept' => 'application/json',  
    'X-API-KEY' => 'API_KEY',  
);  
  
$client = new \GuzzleHttp\Client([  
    'base_uri' => 'https://goapi.unisender.ru/ru/transactional/api/v1/'  
]);  
  
$requestBody = [  
  "from_email" => "email@example.com",  
  "from_name" => "Example",  
  "to_email" => "email@example.com"  
];  
  
try {  
    $response = $client->request('POST','email/subscribe.json', array(  
        'headers' => $headers,  
        'json' => $requestBody,  
       )  
    );  
    print_r($response->getBody()->getContents());  
 }  
 catch (\GuzzleHttp\Exception\BadResponseException $e) {  
    // handle exception or api errors.  
    print_r($e->getMessage());  
 }  
  
 // ...  
```

```python
import requests  
  
base_url = 'https://goapi.unisender.ru/ru/transactional/api/v1'  
headers = {  
  'Content-Type': 'application/json',  
  'Accept': 'application/json',  
  'X-API-KEY': 'API_KEY'  
}  
  
request_body = {  
  "from_email": "email@example.com",  
  "from_name": "Example",  
  "to_email": "email@example.com"  
}  
r = requests.post(base_url+'/email/subscribe.json', json=request_body, headers=headers)  
r.raise_for_status()  # throw an exception in case of error  
print(r.json())  
```

```ruby
require 'rest-client'  
require 'json'  
  
headers = {  
  'Content-Type' => 'application/json',  
  'Accept' => 'application/json',  
  'X-API-KEY' => 'API_KEY'  
}  
  
params = {  
  "from_email" => "email@example.com",  
  "from_name" => "Example",  
  "to_email" => "email@example.com"  
}  
  
begin  
  result = RestClient.post(  
    'https://goapi.unisender.ru/ru/transactional/api/v1/email/subscribe.json',  
    params.to_json,  
    headers  
  )  
  
  p JSON.parse(result)  
rescue RestClient::ExceptionWithResponse => e  
  puts e.response.code  
  puts e.response.body  
end  
```

--------------------------------

### Retrieve Event Dump Properties

Source: https://godocs.unisender.ru/web-api-ref

Examples for accessing the event-dump-get endpoint across various programming languages.

```http
POST https://goapi.unisender.ru/ru/transactional/api/v1/event-dump/get.json HTTP/1.1  
Host: goapi.unisender.ru  
Content-Type: application/json  
Accept: application/json  
  
{  
  "dump_id": "Gqfasjh34tlasd"  
}  
```

```php
<?php  
  
require 'vendor/autoload.php';  
  
$headers = array(  
    'Content-Type' => 'application/json',  
    'Accept' => 'application/json',  
    'X-API-KEY' => 'API_KEY',  
);  
  
$client = new \GuzzleHttp\Client([  
    'base_uri' => 'https://goapi.unisender.ru/ru/transactional/api/v1/'  
]);  
  
$requestBody = [  
  "dump_id" => "Gqfasjh34tlasd"  
];  
  
try {  
    $response = $client->request('POST','event-dump/get.json', array(  
        'headers' => $headers,  
        'json' => $requestBody,  
       )  
    );  
    print_r($response->getBody()->getContents());  
 }  
 catch (\GuzzleHttp\Exception\BadResponseException $e) {  
    // handle exception or api errors.  
    print_r($e->getMessage());  
 }  
  
 // ...  
```

```python
import requests  
  
base_url = 'https://goapi.unisender.ru/ru/transactional/api/v1'  
headers = {  
  'Content-Type': 'application/json',  
  'Accept': 'application/json',  
  'X-API-KEY': 'API_KEY'  
}  
  
request_body = {  
  "dump_id": "Gqfasjh34tlasd"  
}  
r = requests.post(base_url+'/event-dump/get.json', json=request_body, headers=headers)  
r.raise_for_status()  # throw an exception in case of error  
print(r.json())  
```

```ruby
require 'rest-client'  
require 'json'  
  
headers = {  
  'Content-Type' => 'application/json',  
  'Accept' => 'application/json',  
  'X-API-KEY' => 'API_KEY'  
}  
  
params = {  
  "dump_id" => "Gqfasjh34tlasd"  
}  
  
begin  
  result = RestClient.post(  
    'https://goapi.unisender.ru/ru/transactional/api/v1/event-dump/get.json',  
    params.to_json,  
    headers  
  )  
  
  p JSON.parse(result)  
rescue RestClient::ExceptionWithResponse => e  
  puts e.response.code  
  puts e.response.body  
end  
```

```csharp
using System;  
using System.IO;  
using System.Text;  
using System.Net.Http;  
using System.Net.Http.Headers;  
  
class Program {  
  static HttpClient client;  
  
  public static void Main(string[] args) {  
    client = new HttpClient();  
  
    client.BaseAddress = new Uri("https://goapi.unisender.ru/ru/transactional/api/v1/");  
    client.DefaultRequestHeaders.Add("X-API-KEY", "API_KEY");  
    client.DefaultRequestHeaders.Accept.Add(  
      new MediaTypeWithQualityHeaderValue("application/json"));  
  
    string requestBody = "{"  
    +"  \"dump_id\": \"Gqfasjh34tlasd\""  
    +"}";  
    var content = new StringContent(requestBody, Encoding.UTF8, "application/json");  
  
    var response = client.PostAsync("event-dump/get.json", content).Result;  
    var responseBody = response.Content.ReadAsStringAsync().Result;  
    if(response.IsSuccessStatusCode) {  
        Console.WriteLine(responseBody);  
    }  
    else {  
      Console.WriteLine(String.Format("Request failed (HTTP {0}): {1}",  
        (int)response.StatusCode, responseBody));  
    }  
  }  
}  
```

```java
URL obj = new URL("https://goapi.unisender.ru/ru/transactional/api/v1/event-dump/get.json");  
HttpURLConnection con = (HttpURLConnection) obj.openConnection();  
con.setRequestMethod("POST");  
con.setRequestProperty("Content-Type", "application/json");  
con.setRequestProperty("Accept", "application/json");  
con.setRequestProperty("X-API-KEY", "API_KEY");  
con.setDoOutput(true);  
String requestBody = "{"  
    +"  \"dump_id\": \"Gqfasjh34tlasd\""  
    +"}";  
  
try (OutputStream out = con.getOutputStream()) {   
    out.write(requestBody.getBytes());  
    out.flush();  
}  
int responseCode = con.getResponseCode();  
BufferedReader in = new BufferedReader(  
    new InputStreamReader(con.getInputStream()));  
String inputLine;  
StringBuffer response = new StringBuffer();  
while ((inputLine = in.readLine()) != null) {  
    response.append(inputLine);  
}  
in.close();  
System.out.println(responseCode);  
System.out.println(response.toString());  
```

```javascript
const fetch = require('node-fetch');  
const headers = {  
  'Content-Type':'application/json',  
  'Accept':'application/json',  
  'X-API-KEY':'API_KEY'  
};  
  
const inputBody = {  
  "dump_id": "Gqfasjh34tlasd"  
};  
fetch('https://goapi.unisender.ru/ru/transactional/api/v1/event-dump/get.json',  
{  
  method: 'POST',  
  body: JSON.stringify(inputBody),  
  headers: headers  
})  
.then(function(res) {  
    return res.json();  
}).then(function(body) {  
    console.log(body);  
});  
```

--------------------------------

### Define date substitution

Source: https://godocs.unisender.ru/velocity-use-cases

Example of defining a date variable in the substitutions object. Variables must start with 'date_'.

```json
...
 "substitutions": 
        {
          "date_Birthdate":"01/01/1970" 
        }
```

--------------------------------

### Create a project using C#

Source: https://godocs.unisender.ru/web-api-ref

Uses HttpClient to send a POST request to the project creation endpoint.

```csharp
using System;  
using System.IO;  
using System.Text;  
using System.Net.Http;  
using System.Net.Http.Headers;  
  
class Program {  
  static HttpClient client;  
  
  public static void Main(string[] args) {  
    client = new HttpClient();  
  
    client.BaseAddress = new Uri("https://goapi.unisender.ru/ru/transactional/api/v1/");  
    client.DefaultRequestHeaders.Add("X-API-KEY", "API_KEY");  
    client.DefaultRequestHeaders.Accept.Add(  
      new MediaTypeWithQualityHeaderValue("application/json"));  
  
    string requestBody = "{"  
    +"  \"project\": {"  
    +"    \"name\": \"Project 1A\","  
    +"    \"country\": \"ES\","  
    +"    \"send_enabled\": true,"  
    +"    \"custom_unsubscribe_url_enabled\": true,"  
    +"    \"backend_domain_id\": 1234,"  
    +"    \"unsubscribe_page_id\": 1"  
    +"  }"  
    +"}";  
    var content = new StringContent(requestBody, Encoding.UTF8, "application/json");  
  
    var response = client.PostAsync("project/create.json", content).Result;  
    var responseBody = response.Content.ReadAsStringAsync().Result;  
    if(response.IsSuccessStatusCode) {  
        Console.WriteLine(responseBody);  
    }  
    else {  
      Console.WriteLine(String.Format("Request failed (HTTP {0}): {1}",  
        (int)response.StatusCode, responseBody));  
    }  
  }  
}  
```

--------------------------------

### GET /suppression/list

Source: https://godocs.unisender.ru/web-api-ref

Retrieves a list of suppressed email addresses based on optional filters like cause, source, and start time, supporting cursor-based pagination.

```APIDOC
## GET /suppression/list

### Description
Returns a list of addresses that have been added to the suppression list, starting from a specified date or using a cursor for pagination.

### Method
GET

### Endpoint
/suppression/list

### Parameters
#### Query Parameters
- **cause** (string) - Optional - The reason for suppression (unsubscribed, temporary_unavailable, permanent_unavailable, complained, blocked).
- **source** (string) - Optional - The source of the suppression (user, system, subscriber).
- **start_time** (string) - Optional - Date in YYYY-MM-DD HH:MM:SS format to filter records. Ignored if cursor is provided.
- **cursor** (string) - Optional - Pagination cursor for fetching subsequent pages.
- **limit** (integer) - Optional - Maximum number of records to return (default 50).

### Response
#### Success Response (200)
- **status** (string) - The string "success".
- **suppressions** (array) - List of suppression objects.
  - **email** (string) - The suppressed email address.
  - **cause** (string) - Reason for suppression.
  - **source** (string) - Source of suppression.
  - **is_deletable** (boolean) - Indicates if the record can be deleted.
  - **created** (string) - Timestamp of suppression in UTC.
- **cursor** (string) - Cursor for the next page of results.

#### Response Example
{
  "status": "success",
  "suppressions": [
    {
      "email": "user@example.com",
      "cause": "unsubscribed",
      "source": "user",
      "is_deletable": true,
      "created": "2021-12-19 10:15:49"
    }
  ],
  "cursor": "Ajfb6Hvdkn3hdhhvG57xbdufhG5"
}
```

--------------------------------

### Create a project using Java

Source: https://godocs.unisender.ru/web-api-ref

Uses HttpURLConnection to perform a POST request to the API.

```java
URL obj = new URL("https://goapi.unisender.ru/ru/transactional/api/v1/project/create.json");  
HttpURLConnection con = (HttpURLConnection) obj.openConnection();  
con.setRequestMethod("POST");  
con.setRequestProperty("Content-Type", "application/json");  
con.setRequestProperty("Accept", "application/json");  
con.setRequestProperty("X-API-KEY", "API_KEY");  
con.setDoOutput(true);  
String requestBody = "{"  
    +"  \"project\": {"  
    +"    \"name\": \"Project 1A\","  
    +"    \"country\": \"ES\","  
    +"    \"send_enabled\": true,"  
    +"    \"custom_unsubscribe_url_enabled\": true,"  
    +"    \"backend_domain_id\": 1234,"  
    +"    \"unsubscribe_page_id\": 1"  
    +"  }"  
    +"}";  
  
try (OutputStream out = con.getOutputStream()) {   
    out.write(requestBody.getBytes());  
    out.flush();  
}  
int responseCode = con.getResponseCode();  
BufferedReader in = new BufferedReader(  
    new InputStreamReader(con.getInputStream()));  
String inputLine;  
StringBuffer response = new StringBuffer();  
while ((inputLine = in.readLine()) != null) {  
    response.append(inputLine);  
}  
in.close();  
System.out.println(responseCode);  
System.out.println(response.toString());  
```

--------------------------------

### Create a new project

Source: https://godocs.unisender.ru/web-api-ref

Creates a new project with specified settings. Requires project creation methods to be enabled by support.

```http
POST https://goapi.unisender.ru/ru/transactional/api/v1/project/create.json HTTP/1.1  
Host: goapi.unisender.ru  
Content-Type: application/json  
Accept: application/json  
  
{  
  "project": {  
    "name": "Project 1A",  
    "country": "ES",  
    "send_enabled": true,  
    "custom_unsubscribe_url_enabled": true,  
    "backend_domain_id": 1234,  
    "unsubscribe_page_id": 1  
  }  
}  
```

```php
<?php  
  
require 'vendor/autoload.php';  
  
$headers = array(  
    'Content-Type' => 'application/json',  
    'Accept' => 'application/json',  
    'X-API-KEY' => 'API_KEY',  
);  
  
$client = new \GuzzleHttp\Client([  
    'base_uri' => 'https://goapi.unisender.ru/ru/transactional/api/v1/'  
]);  
  
$requestBody = [  
  "project" => [  
    "name" => "Project 1A",  
    "country" => "ES",  
    "send_enabled" => true,  
    "custom_unsubscribe_url_enabled" => true,  
    "backend_domain_id" => 1234,  
    "unsubscribe_page_id" => 1  
  ]  
];  
  
try {  
    $response = $client->request('POST','project/create.json', array(  
        'headers' => $headers,  
        'json' => $requestBody,  
       )  
    );  
    print_r($response->getBody()->getContents());  
 }  
 catch (\GuzzleHttp\Exception\BadResponseException $e) {  
    // handle exception or api errors.  
    print_r($e->getMessage());  
 }  
  
 // ...  
```

```python
import requests  
  
base_url = 'https://goapi.unisender.ru/ru/transactional/api/v1'  
headers = {  
  'Content-Type': 'application/json',  
  'Accept': 'application/json',  
  'X-API-KEY': 'API_KEY'  
}  
  
request_body = {  
  "project": {  
    "name": "Project 1A",  
    "country": "ES",  
    "send_enabled": true,  
    "custom_unsubscribe_url_enabled": true,  
    "backend_domain_id": 1234,  
    "unsubscribe_page_id": 1  
  }  
}  
r = requests.post(base_url+'/project/create.json', json=request_body, headers=headers)  
r.raise_for_status()  # throw an exception in case of error  
print(r.json())  
```

```ruby
require 'rest-client'  
require 'json'  
  
headers = {  
  'Content-Type' => 'application/json',  
  'Accept' => 'application/json',  
  'X-API-KEY' => 'API_KEY'  
}  
  
params = {  
  "project" => {  
    "name" => "Project 1A",  
    "country" => "ES",  
    "send_enabled" => true,  
    "custom_unsubscribe_url_enabled" => true,  
    "backend_domain_id" => 1234,  
    "unsubscribe_page_id" => 1  
  }  
}  
  
begin  
  result = RestClient.post(  
    'https://goapi.unisender.ru/ru/transactional/api/v1/project/create.json',  
    params.to_json,  
    headers  
  )  
  
  p JSON.parse(result)  
rescue RestClient::ExceptionWithResponse => e  
  puts e.response.code  
  puts e.response.body  
end  
```

--------------------------------

### Suppression List Response Example

Source: https://godocs.unisender.ru/web-api-ref

Example of a successful 200 OK response containing suppression details for a specific email.

```json
{
  "status": "success",
  "email": "user@example.com",
  "suppressions": [
    {
      "project_id": "6123462132634",
      "cause": "unsubscribed",
      "source": "user",
      "is_deletable": true,
      "created": "2021-12-19 10:15:49"
    }
  ]
}
```

--------------------------------

### Create Event Dump via API

Source: https://godocs.unisender.ru/web-api-ref

Examples for initiating an event dump request using different programming languages. Ensure the X-API-KEY header is set correctly for authentication.

```csharp
using System;  
using System.IO;  
using System.Text;  
using System.Net.Http;  
using System.Net.Http.Headers;  
  
class Program {  
  static HttpClient client;  
  
  public static void Main(string[] args) {  
    client = new HttpClient();  
  
    client.BaseAddress = new Uri("https://goapi.unisender.ru/ru/transactional/api/v1/");  
    client.DefaultRequestHeaders.Add("X-API-KEY", "API_KEY");  
    client.DefaultRequestHeaders.Accept.Add(  
      new MediaTypeWithQualityHeaderValue("application/json"));  
  
    string requestBody = "{"  
    +"  \"start_time\": \"2022-07-20 00:00:00\","  
    +"  \"end_time\": \"2022-07-21 00:00:00\","  
    +"  \"limit\": 50,"  
    +"  \"all_projects\": false,"  
    +"  \"filter\": {"  
    +"    \"job_id\": \"1ZymBc-00041N-9X\","  
    +"    \"status\": \"sent\","  
    +"    \"delivery_status\": \"string\","  
    +"    \"email\": \"david@example.org\","  
    +"    \"email_from\": \"sender@example.com\","  
    +"    \"domain\": \"example.org\","  
    +"    \"campaign_id\": \"c77f4f4e-3561-49f7-9f07-c35be01b4f43\""  
    +"  },"  
    +"  \"dump_fields\": ["  
    +"    \"string1\""  
    +"  ],"  
    +"  \"aggregate\": \"day_status\","  
    +"  \"delimiter\": \";\",
```
Tokens:
Raw