Skip to content

CampaignActionApi.md

Latest commit

 

History

History
271 lines (188 loc) · 6.94 KB

CampaignActionApi.md

File metadata and controls

271 lines (188 loc) · 6.94 KB
Raw

CampaignActionApi

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

Method HTTP request Description
campaignActionCreate POST /v4/api/campaign-action
campaignActionDelete DELETE /v4/api/campaign-action/{id}
campaignActionGet GET /v4/api/campaign-action/{id}
campaignActionSearch GET /v4/api/campaign-action
campaignActionUpdate PUT /v4/api/campaign-action/{id}

campaignActionCreate

CampaignAction campaignActionCreate(body)

Create a campaign action.

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.CampaignActionApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


CampaignActionApi apiInstance = new CampaignActionApi();
CampaignActionCreate body = new CampaignActionCreate(); // CampaignActionCreate | 
try {
    CampaignAction result = apiInstance.campaignActionCreate(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CampaignActionApi#campaignActionCreate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body CampaignActionCreate [optional]

Return type

CampaignAction

Authorization

Bearer

HTTP request headers

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

campaignActionDelete

campaignActionDelete(id)

Remove a campaign action.

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.CampaignActionApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


CampaignActionApi apiInstance = new CampaignActionApi();
String id = "id_example"; // String | 
try {
    apiInstance.campaignActionDelete(id);
} catch (ApiException e) {
    System.err.println("Exception when calling CampaignActionApi#campaignActionDelete");
    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

campaignActionGet

CampaignAction campaignActionGet(id)

Retrieve a campaign action.

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.CampaignActionApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


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

Parameters

Name Type Description Notes
id String

Return type

CampaignAction

Authorization

Bearer

HTTP request headers

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

campaignActionSearch

CampaignActionPaginationResponse campaignActionSearch(filter, query, page, perPage, sort)

Search campaign actions.

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.CampaignActionApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


CampaignActionApi apiInstance = new CampaignActionApi();
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 {
    CampaignActionPaginationResponse result = apiInstance.campaignActionSearch(filter, query, page, perPage, sort);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CampaignActionApi#campaignActionSearch");
    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

CampaignActionPaginationResponse

Authorization

Bearer

HTTP request headers

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

campaignActionUpdate

CampaignAction campaignActionUpdate(id, body)

Update a campaign action.

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.CampaignActionApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


CampaignActionApi apiInstance = new CampaignActionApi();
String id = "id_example"; // String | 
CampaignActionUpdate body = new CampaignActionUpdate(); // CampaignActionUpdate | 
try {
    CampaignAction result = apiInstance.campaignActionUpdate(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CampaignActionApi#campaignActionUpdate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String
body CampaignActionUpdate [optional]

Return type

CampaignAction

Authorization

Bearer

HTTP request headers

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