Skip to content

EmailActivityApi.md

Latest commit

 

History

History
271 lines (188 loc) · 6.84 KB

EmailActivityApi.md

File metadata and controls

271 lines (188 loc) · 6.84 KB
Raw

EmailActivityApi

All URIs are relative to https://app.statflo.com

Method HTTP request Description
emailActivityCreate POST /v4/api/email-activity
emailActivityDelete DELETE /v4/api/email-activity/{id}
emailActivityGet GET /v4/api/email-activity/{id}
emailActivitySearch GET /v4/api/email-activity
emailActivityUpdate PUT /v4/api/email-activity/{id}

emailActivityCreate

EmailActivity emailActivityCreate(body)

Create email activity

Example

// Import classes:
//import com.statflo.client.ApiClient;
//import com.statflo.client.ApiException;
//import com.statflo.client.Configuration;
//import com.statflo.client.auth.*;
//import com.statflo.client.api.EmailActivityApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


EmailActivityApi apiInstance = new EmailActivityApi();
EmailActivityCreate body = new EmailActivityCreate(); // EmailActivityCreate | 
try {
    EmailActivity result = apiInstance.emailActivityCreate(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EmailActivityApi#emailActivityCreate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body EmailActivityCreate [optional]

Return type

EmailActivity

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

emailActivityDelete

emailActivityDelete(id)

Remove an email activity

Example

// Import classes:
//import com.statflo.client.ApiClient;
//import com.statflo.client.ApiException;
//import com.statflo.client.Configuration;
//import com.statflo.client.auth.*;
//import com.statflo.client.api.EmailActivityApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


EmailActivityApi apiInstance = new EmailActivityApi();
String id = "id_example"; // String | 
try {
    apiInstance.emailActivityDelete(id);
} catch (ApiException e) {
    System.err.println("Exception when calling EmailActivityApi#emailActivityDelete");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String

Return type

null (empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

emailActivityGet

EmailActivity emailActivityGet(id)

Retrieve an email activity

Example

// Import classes:
//import com.statflo.client.ApiClient;
//import com.statflo.client.ApiException;
//import com.statflo.client.Configuration;
//import com.statflo.client.auth.*;
//import com.statflo.client.api.EmailActivityApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


EmailActivityApi apiInstance = new EmailActivityApi();
String id = "id_example"; // String | 
try {
    EmailActivity result = apiInstance.emailActivityGet(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EmailActivityApi#emailActivityGet");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String

Return type

EmailActivity

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

emailActivitySearch

EmailActivityPaginationResponse emailActivitySearch(filter, query, page, perPage, sort)

Search email activity

Example

// Import classes:
//import com.statflo.client.ApiClient;
//import com.statflo.client.ApiException;
//import com.statflo.client.Configuration;
//import com.statflo.client.auth.*;
//import com.statflo.client.api.EmailActivityApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


EmailActivityApi apiInstance = new EmailActivityApi();
java.util.HashMap filter = new java.util.HashMap(); // java.util.HashMap | 
String query = "query_example"; // String | 
Integer page = 56; // Integer | 
Integer perPage = 56; // Integer | 
String sort = "sort_example"; // String | 
try {
    EmailActivityPaginationResponse result = apiInstance.emailActivitySearch(filter, query, page, perPage, sort);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EmailActivityApi#emailActivitySearch");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
filter java.util.HashMap [optional]
query String [optional]
page Integer [optional]
perPage Integer [optional]
sort String [optional]

Return type

EmailActivityPaginationResponse

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

emailActivityUpdate

EmailActivity emailActivityUpdate(id, body)

Update an email activity

Example

// Import classes:
//import com.statflo.client.ApiClient;
//import com.statflo.client.ApiException;
//import com.statflo.client.Configuration;
//import com.statflo.client.auth.*;
//import com.statflo.client.api.EmailActivityApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


EmailActivityApi apiInstance = new EmailActivityApi();
String id = "id_example"; // String | 
EmailActivityUpdate body = new EmailActivityUpdate(); // EmailActivityUpdate | 
try {
    EmailActivity result = apiInstance.emailActivityUpdate(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EmailActivityApi#emailActivityUpdate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String
body EmailActivityUpdate [optional]

Return type

EmailActivity

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json